DocMate 智能写作助手

功能介绍

DocMate 是专为开源社区文档打造的 VS Code 智能写作助手。它为文档创作提供全流程的 AI 支持,有效提升文档的规范性与写作效率,让每一位开发者都能轻松写出专业级技术文档。

  • 文档检查
    • 中文错别字检查;
    • 标点符号规范;
    • 空格规范;
    • 格式规范;
    • 风格一致性;
    • 超链接检查;
    • 术语规范。
  • 文本润色
    • 表达优化:提升文档的清晰度和专业性;
    • 结构调整:优化段落结构与语句逻辑;
    • 语言精炼:简化技术表达,使其更加简明易懂。
  • 智能重写
    • 支持自定义重写指令,满足多样化的内容需求。

使用方法

  • 安装插件

    1. 打开 VS Code,进入扩展商店(Ctrl+Shift+X);

    2. 搜索“DocMate”,点击安装;

      docmate check

    3. 点击左侧活动栏的DocMate图标,打开专用侧边栏。

  • 配置AI服务

    1. 点击侧边栏右上角的设置图标;
    2. 用户需自行获取模型服务,可参考指导进行配置;
  • 基本使用

    1. 打开文档:在 VS Code 中打开 Markdown 文件;
    2. 选择文本:选中需要处理的文本内容;
    3. 按需进行检查、润色或改写;
    4. 查看处理结果和建议,可一键应用改进建议。

    docmate use

  • 检查项配置

    1. 点击侧边栏右上角的检查规则管理图标;
    2. 查看默认检查规则;
    3. 通过开关控制,灵活启用/禁用检查项;
    4. 点击右上角的新建规则按钮,自定义符合特定需求的检查规则。

    docmate config

使用示例

  • 检查

    docmate check

  • 润色

    docmate improve

  • 改写

    docmate rewrite