# docmate

**Repository Path**: openeuler/docmate

## Basic Information

- **Project Name**: docmate
- **Description**: An AI-powered VS Code extension for intelligent document creation in openEuler community.
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-07-03
- **Last Updated**: 2025-10-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: infrastructure

## README

# DocMate - openEuler Intelligent Writing Assistant

DocMate is a VS Code intelligent writing assistant specifically designed for openEuler documentation. It provides comprehensive support for technical document creation through AI technology, helping improve document quality, standardize writing conventions, and make documentation more efficient and professional.

## ✨ Key Features

### 🔍 Intelligent Document Checking

- **Grammar Check**: Automatically identify and correct grammatical errors
- **Writing Style**: Standardize the expression style of technical documents
- **Content Consistency**: Ensure logical coherence and terminology consistency

### ✨ AI Text Polishing

- **Expression Optimization**: Enhance document clarity and professionalism
- **Structure Adjustment**: Optimize paragraph structure and logical flow
- **Language Refinement**: Make technical expressions more concise and clear
- **Intelligent Chunk Processing**: Markdown structure-aware chunking algorithm for optimized long document processing

### 🌐 Multi-language Translation

- **Chinese-English Translation**: Support professional translation between Chinese and English
- **Terminology Preservation**: Maintain accuracy and consistency of technical terms
- **Context Understanding**: Provide precise translation based on document context

### ✏️ Intelligent Rewriting

- **Content Rewriting**: Reorganize and express content according to requirements
- **Style Adjustment**: Adapt expression styles for different target audiences
- **Quality Enhancement**: Comprehensively improve document readability and professionalism

## 🚀 Quick Start

### Install Extension

1. Open VS Code
2. Go to Extensions Marketplace (Ctrl+Shift+X)
3. Search for "DocMate"
4. Click Install

### Basic Usage

1. **Open Document**: Open Markdown or text files in VS Code
2. **Select Text**: Select the text content you want to process
3. **Choose Function**:
   - Right-click menu to select DocMate functions
   - Use DocMate sidebar panel
   - Command Palette (Ctrl+Shift+P) search for DocMate

### Sidebar Panel

Click the DocMate icon in the activity bar to open the dedicated sidebar:

- View processing results and suggestions
- Apply improvement suggestions with one click (supports word-level precision replacement)
- Adjust function parameter settings
- Smart issue management (supports line number display and batch processing)

## ⚙️ Configuration Options

When you first open the plugin, you will be asked to fill in the model, URL, API key, etc. You can change these settings later in the plugin settings.

## 💡 Usage Tips

### Document Checking

- Recommend performing comprehensive checks after completing the first draft
- Can check long documents in sections to ensure processing effectiveness
- Pay attention to terminology and style suggestions in check results

### Text Polishing

- Suitable for quality improvement of existing content
- Can perform fine polishing on specific paragraphs
- Recommend keeping original text backup for comparison

### Translation Function

- Support quick translation of selected text
- Maintain professionalism of technical terminology
- Suitable for creating bilingual documents

## 🔮 Future Development Plans

We are actively developing more features to make DocMate a more powerful writing assistant:

### Coming Soon

- 📚 **Terminology Management**: Built-in openEuler professional terminology database with custom term support
- 📝 **Document Templates**: Provide standardized document templates and format specifications
- 🎯 **Real-time Checking**: Real-time grammar and style checking during input
- 📊 **Quality Scoring**: Quantitative assessment and improvement suggestions for document quality

### Long-term Planning

- 🤖 **Smart Completion**: Context-based intelligent content completion
- 🔗 **Document Correlation**: Cross-document content consistency checking
- 📈 **Writing Analysis**: Personal writing habit analysis and improvement suggestions
- 🌍 **Multi-language Support**: Extend translation and checking for more languages

## 📞 Feedback & Support

Your feedback is very important to us!

### Issue Reporting

- [Submit Issue](https://gitee.com/openeuler/docmate/issues)

### Get Help

- Join [Community Discussion](https://gitee.com/openeuler/docmate)

### Contact Us

- Project Repository: https://gitee.com/openeuler/docmate
- openEuler Community: https://openeuler.org

## 📄 License

This project is licensed under the Mulan Permissive Software License v2. See [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

Thanks to the openEuler community for their support and all contributors for their efforts in making technical documentation writing more intelligent and efficient.