AI Proofreader便查图表

这是我做的校对工具AI Proofreader的cheatsheet，命令、操作流程、业务逻辑等方面的便查图表。本文档由AI辅助生成。

v1.12.8

文档定位：本文档是快速入口——帮你从业务场景找到对应流程和命令。详细说明、依赖安装、最佳实践见扩展主页面或 README；完整版本历史见 changelog。

30 秒概览#

四个入口：（1）左侧活动栏 overview：打开校对面板 / 检索面板，并开关侧栏 TreeView；（2）校对面板按四块组织日常工作；（3）检索面板是「切分与合并」的资料检索分支（不做校对）；（4）命令面板（Ctrl+Shift+P）输入「AI Proofreader」可查全部命令；部分命令也有右键菜单。

术语简表#

目录#

• 一、各业务场景快速入口
• 二、业务词汇 → 功能对照
• 三、典型业务流程（Mermaid 图）
• 四、命令速查表
• 五、重要设置项
• 六、用户扩展能力
• 七、说明与建议

一、各业务场景快速入口#

按校对面板四块 + 资料检索分支操作。流程图见 第三节。稿件类型示例见 1.6。

1.1 文档整理#

1.2 切分与合并#

1.3 资料检索（切分与合并的分支）#

JSON：切分区块 「准备参考资料」。选段：overview → 检索面板（不必先切分）。检索面板不做校对。

1.4 校对 / 校对结果#

1.5 专项检查#

1.6 按稿件类型#

二、业务词汇 → 功能对照#

用 Ctrl+F 搜索业务词，快速定位功能。

三、典型业务流程（Mermaid 图）#

3.1 两种主要校对路径#

flowchart LR
    subgraph 方式一["选段校对"]
        S1["打开 Markdown"]
        S2["选中一段文字"]
        S3["面板底部：校对选中文本<br/>（或带编辑记忆）"]
        S4["查看 diff → 写回选区"]
        S1 --> S2 --> S3 --> S4
    end

    subgraph 方式二["长文档校对"]
        L1["文档整理"]
        L2["切分与合并"]
        L3["可选：资料检索"]
        L4["LLM 校对 JSON"]
        L5["校对结果：diff / 勘误表"]
        L1 --> L2 --> L3 --> L4 --> L5
        L2 --> L4
    end

3.2 长文档校对整体流程#

flowchart TB
    subgraph 整理["📄 文档整理"]
        A["原始稿：docx / PDF / text / TeX"]
        B["转换格式 / 整理段落标点 / 标记或对齐标题"]
        C["可校对之 Markdown"]
        A --> B --> C
    end

    subgraph 切分合并["✂️ 切分与合并"]
        C --> D["选择主文件 → 切分文档"]
        D --> E["filename.json + .json.md"]
        E --> F["可选：合并 JSON 组织语境"]
    end

    subgraph 检索["🔎 资料检索（分支）"]
        E --> G["准备参考资料"]
        G --> H["检索面板勾选 → 导出 md / 合并到源 JSON"]
    end

    subgraph 校对结果["✏️ 校对 / 校对结果"]
        F --> I["LLM 校对 JSON"]
        H --> I
        E --> I
        I --> J["校对结果：前后差异 / 差异文件 / 勘误表"]
        C --> K["底部：选段校对"]
        K --> J
    end

    subgraph 专项["🔍 专项检查"]
        C --> L["字词 / 标题树 / 段内序号 / 对齐标题 / 重文 / 引文"]
    end

3.3 切分模式选择（决策简图）#

flowchart TD
    Start["我要切分 Markdown"] --> Q1{"有标题结构?"}
    Q1 -->|无| ByLen["按长度切分 <br> split by length"]
    Q1 -->|有| Q2{"题下段落长度合适?"}
    Q2 -->|是且不太长| ByTitle["按标题切分 <br> split by title"]
    Q2 -->|长短不一| ByTitleLen["按标题+长度 <br> split by title and length"]
    Q2 -->|需要整章作语境| WithTitleCtx["带标题范围上下文 <br> split by length with title context"]
    Q1 -->|有只需前后段语境| WithParaCtx["带前后段落上下文 <br> split by length with paragraph context"]

    ByLen --> Out["得到 .json + .json.md"]
    ByTitle --> Out
    ByTitleLen --> Out
    WithTitleCtx --> Out
    WithParaCtx --> Out

3.4 比较与生成勘误表/审校记录#

flowchart TD
    Diff["与另一文件比较差异 <br> diff it with another file"] --> Mode{"选择模式"}
    Mode -->|VS Code 内置| A["左右对比 diff"]
    Mode -->|jsdiff HTML| B["生成带修改标记的 HTML <br> 可打印 PDF"]
    Mode -->|逐句对齐| C["生成勘误表 HTML <br> 可筛选、对比"]

3.5 引文核对流程#

flowchart LR
    A["设置文献库路径"] --> B["检索面板：建立参考资料索引"]
    B --> C["核对选中引文 / 核对全文引文"]
    C --> D["侧栏「引文核查」"]
    D --> E["diff / PDF 反查"]

四、命令速查表#

优先用 UI，按校对面板四块 + 资料检索分支：

• 文档整理 / 切分与合并 / 校对结果 / 专项检查：overview「校对面板」或 open proofreading panel
• 资料检索：切分区块「准备参考资料」，或 overview「检索面板」。校对请到校对面板。
• 命令面板（Ctrl+Shift+P）输入「AI Proofreader」可查全部。⭐ 表示核心/常用。

五、重要设置项#

进入方式：VS Code 左下角 齿轮 ⚙️ → 扩展 → AI Proofreader → 设置；或 overview / 校对面板 「设置」；或 Preferences: Open Settings (UI)，搜索 ai-proofread。

5.1 必配：大模型与 API#

5.2 常用：校对行为与切分#

5.3 进阶：勘误表、引文、字词、序号、检索缓存#

完整配置说明见 README - 配置。

六、用户扩展能力#

用户可通过以下方式扩展或定制扩展行为，无需改代码。

详细说明见扩展主页面或 README。

七、说明与建议#

• Mermaid 图：可在支持 Mermaid 的 Markdown 预览（如 VS Code 插件）、GitHub/GitLab、Notion 等中直接渲染为流程图。
• 命令查找：命令面板输入「AI Proofreader」或「proofread」「split」「Search」等关键词即可缩小范围。
• 详细说明：每个命令的详细用法、依赖（Pandoc、pdftotext、SumatraPDF 等）和注意事项见扩展主页面或 README；设置说明可在设置界面看到。版本历史见 changelog。
• 面板分工：校对面板四块为 文档整理、切分与合并、校对结果、专项检查；资料检索是切分与合并的分支（检索面板）。引文核对在检索面板与专项检查区都有入口。

评论