DocMate - openEuler 智能写作助手

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

✨ 主要功能

🔍 智能文档检查

• 语法检查：自动识别并纠正语法错误
• 写作风格：统一技术文档的表达风格
• 内容一致性：确保文档逻辑连贯、术语统一

✨ AI 文本润色

• 表达优化：提升文档的清晰度和专业性
• 结构调整：优化段落结构和逻辑流程
• 语言精炼：让技术表达更加简洁明了

🌐 多语言翻译

• 中英互译：支持中文与英文之间的专业翻译
• 术语保持：保持技术术语的准确性和一致性
• 上下文理解：基于文档上下文提供精准翻译

✏️ 智能重写

• 内容改写：根据需求重新组织和表达内容
• 风格调整：适应不同读者群体的表达方式
• 质量提升：全面改善文档的可读性和专业度

🚀 快速开始

安装插件

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

基本使用

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

侧边栏面板

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

• 查看处理结果和建议
• 一键应用改进建议
• 调整功能参数设置

⚙️ 配置选项

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

💡 使用技巧

文档检查

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

文本润色

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

翻译功能

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

🔮 后续开发计划

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

即将推出

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

长期规划

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

📞 反馈与支持

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

问题反馈

• 提交 Issue

获取帮助

• 参与 社区讨论

联系我们

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

📄 许可证

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

🙏 致谢

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