# 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-09-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: infrastructure

## README

# DocMate - openEuler 智能写作助手

DocMate 是专为 openEuler 文档编写设计的 VS Code 智能写作助手。通过 AI 技术为技术文档创作提供全流程支持，帮助提升文档质量、统一写作规范，让文档编写更高效、更专业。

## 🏗️ 技术架构

基于 **LangChain 框架** 构建，采用现代化的 AI 应用架构：

- **LangChain 表达语言 (LCEL)**：声明式的 AI 处理流程，提供清晰可读的代码结构
- **Map-Reduce 处理模式**：智能分块并行处理，支持长文档的高效分析
- **结构化输出**：使用 Zod Schema 确保返回数据的类型安全和一致性
- **模块化设计**：各功能模块独立封装，便于维护和扩展

## ✨ 主要功能

### 🔍 智能文档检查

- **语法检查**：自动识别并纠正语法错误
- **写作风格**：统一技术文档的表达风格
- **内容一致性**：确保文档逻辑连贯、术语统一
- **自定义检查规则**：用户可以自定义检查规则，灵活控制检查内容和标准
- **智能分块处理**：基于LangChain Map-Reduce架构的长文本处理，支持复杂文档的高效检查

### ✨ AI 文本润色

- **表达优化**：提升文档的清晰度和专业性
- **结构调整**：优化段落结构和逻辑流程
- **语言精炼**：让技术表达更加简洁明了
- **智能分块处理**：基于Markdown结构感知的分块算法，优化长文档处理
- **LangChain驱动**：采用LangChain表达式语言（LCEL），提供更精准的语言优化

### 🌐 多语言翻译

- **中英互译**：支持中文与英文之间的专业翻译
- **术语保持**：保持技术术语的准确性和一致性
- **上下文理解**：基于文档上下文提供精准翻译
- **术语库集成**：内置术语处理机制，确保专业术语翻译的准确性

### ✏️ 智能重写

- **内容改写**：根据需求重新组织和表达内容
- **风格调整**：适应不同读者群体的表达方式
- **质量提升**：全面改善文档的可读性和专业度
- **灵活指令**：支持自定义重写指令，满足多样化的内容需求

## 🚀 快速开始

### 安装插件

1. 打开 VS Code
2. 进入扩展商店 (Ctrl+Shift+X)
3. 搜索 "DocMate"
4. 点击安装

### 基本使用

1. **打开文档**：在 VS Code 中打开 Markdown 或文本文件
2. **选择文本**：选中需要处理的文本内容
3. **选择功能**：
   - 右键菜单选择 DocMate 功能
   - 使用侧边栏 DocMate 面板
   - 命令面板 (Ctrl+Shift+P) 搜索 DocMate

### 侧边栏面板

点击活动栏的 DocMate 图标，打开专用侧边栏：

- 查看处理结果和建议
- 一键应用改进建议（支持词级精度替换）
- 调整功能参数设置
- 智能问题管理（支持行号显示和批量处理）
- **检查规则管理**：v1.3.0 新增！在设置中管理自定义检查规则，启用/禁用特定检查项

## ⚙️ 配置选项

### AI 服务配置

初次打开插件时会要求填写使用的模型、url、apikey等，后续可以在插件设置里更改

### 检查规则配置（v1.3.0 新增）

- **规则管理**：在侧边栏设置中访问"管理检查规则"功能
- **自定义规则**：创建符合特定需求的检查规则
- **规则启用/禁用**：灵活控制检查内容和标准
- **默认规则**：提供7种内置检查规则，涵盖错别字、标点、空格、格式、风格、超链接和术语检查

## 💡 使用技巧

### 文档检查

- 建议在文档完成初稿后进行全面检查
- 可以分段检查长文档，确保处理效果
- 关注检查结果中的术语和风格建议

### 文本润色

- 适合对已有内容进行质量提升
- 可以针对特定段落进行精细润色
- 建议保留原文备份，便于对比效果

### 翻译功能

- 支持选中文本的快速翻译
- 保持技术术语的专业性
- 适合创建双语文档

## 🔄 版本历史

### v1.4.0 (最新版本)

**🚀 架构升级：LangChain框架重构**

- **LangChain架构**：全面升级到LangChain框架，采用现代化的AI应用架构
- **性能优化**：基于LCEL的声明式处理流程，提供更高效的AI交互
- **类型安全**：使用Zod Schema确保返回数据的类型安全和一致性
- **代码质量**：重构AI服务层，移除手写API调用代码，提升可维护性

### v1.3.0

**🎉 重大更新：自定义检查规则功能**

- **自定义检查规则**：用户可以创建、编辑和管理自己的检查规则
- **规则管理界面**：直观的UI界面，支持规则的启用/禁用操作
- **动态规则注入**：运行时动态应用用户定义的检查标准
- **工具调用优化**：修复了自定义规则导致的工具调用失败问题
- **性能提升**：优化了规则缓存和处理机制
- **代码重构**：改进了代码结构，提升了可维护性

### v1.2.0

**🚀 智能分块处理与波浪线提示**

- **智能分块算法**：基于Markdown结构感知的分块处理，优化长文档处理效果
- **波浪线提示**：VS Code原生波浪线提示，直观显示文档问题
- **诊断信息**：精确的问题定位和修复建议
- **用户体验优化**：全新的交互设计和视觉体验

## 🔮 后续开发计划

我们正在积极开发更多功能，让 DocMate 成为更强大的写作助手：

### 即将推出

- 📚 **术语库管理**：内置 openEuler 专业术语库，支持自定义术语
- 📝 **文档模板**：提供标准化的文档模板和格式规范
- 🎯 **实时检查**：输入时的实时语法和风格检查
- 📊 **质量评分**：文档质量的量化评估和改进建议

### 长期规划

- 🤖 **智能补全**：基于上下文的内容智能补全
- 🔗 **文档关联**：跨文档的内容一致性检查
- 📈 **写作分析**：个人写作习惯分析和改进建议
- 🌍 **多语言支持**：扩展更多语言的翻译和检查

## 📞 反馈与支持

您的反馈对我们非常重要！

### 问题反馈

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

### 获取帮助

- 参与 [社区讨论](https://gitee.com/openeuler/docmate)

### 联系我们

- 项目仓库：https://gitee.com/openeuler/docmate
- openEuler 社区：https://openeuler.org

## 📄 许可证

本项目采用木兰宽松许可证第 2 版。详见 [LICENSE](LICENSE) 文件。

## 🙏 致谢

感谢 openEuler 社区的支持，感谢所有贡献者的努力，让技术文档写作变得更加智能和高效。