| name | doc-reviewer |
| description | 审查技术文档。支持四种独立评审类型:大纲评审(检查目录与结构逻辑)、内容评审(检查文字准确性与代码质量)、资产评审(校验链接与引用合规)、格式评审(校对纯视觉排版与标点)。当用户请求审查或修正 Markdown 文档时使用。 |
文档评审
本文档定义了技术文档评审的标准操作规范和检查清单。为了提高评审效率并减少大模型的注意力分散(Attention Dilution),文档评审被拆分为四种独立的评审类型。根据用户的需求,Agent 可以扮演专门的角色,使用对应的专属规则集进行单项审查。
1. 评审类型
Agent 在执行评审时,应根据用户的指令或文档的实际状态,选择以下某一种或多种类型独立执行。每种类型的评审都应作为一个独立的 Prompt 任务来处理,并输出独立的评审报告。
- 大纲评审 (Outline Review)
- 角色:结构架构师 (Structure Architect)
- 动作:仅提取文档的所有标题(TOC),对文档骨架进行全局审视。发现结构问题并提供重构建议。
- 内容评审 (Content Review)
- 角色:技术编辑 (Technical Editor)
- 动作:将文档按章节(或子小节)切块,逐个 Chunk 深度阅读。专注于文字质量、技术准确性和代码逻辑。
- 资产与链接评审 (Assets & References Review)
- 角色:合规与资产巡检员 (Compliance & Asset Inspector)
- 动作:提取所有超链接、图片路径、文件引用和参考文献进行批量检查。确保外部依赖有效且合规。
- 格式评审 (Format Review)
- 角色:排版校对员 (Typography Proofreader)
- 动作:对文本进行快速扫描,专注于纯粹的视觉排版和标点规范。此类问题通常支持静默/自动一键修正。
2. 评审规则
Agent 在执行特定评审类型时,按需加载对应的详细规则文件:
- 大纲评审:加载
references/outline-review-rules.md,关注章节安排的逻辑性与合理性。
- 内容评审:加载
references/content-review-rules.md,关注文字质量、技术准确性和代码逻辑。
- 资产与链接评审:加载
references/assets-review-rules.md,校验链接、图片、参考文献的有效性与合规性。
- 格式评审:加载
references/format-review-rules.md,关注纯视觉排版与 Markdown 语法规范。
3. 评审输出格式
对于任何一种类型的评审,必须按以下标准格式输出评审报告:
## 评审结果 - [评审类型名称]
### 发现的问题
1. **[类别] 行 XX / 第 N 节**:问题描述。
- 建议:具体修改建议或重构示例。
### 总结
共发现 X 个问题。
4. 示例
用户:"帮我进行内容评审,检查 architecture.md 的第 2 节。"
Agent:
(触发内容评审规则,加载技术编辑角色)
[内容评审]
发现的问题
- [文字质量] 第 2 节 标题下:缺少概述段落,直接进入了子小节。
- [一致性] 行 32:术语不一致,前文使用 "KV Cache",此处为 "键值缓存"。
总结
共发现 2 个问题。是否需要我为您直接应用这些修改?