with one click
doc-reviewer
// 审查技术文档。支持四种独立评审类型:大纲评审(检查目录与结构逻辑)、内容评审(检查文字准确性与代码质量)、资产评审(校验链接与引用合规)、格式评审(校对纯视觉排版与标点)。当用户请求审查或修正 Markdown 文档时使用。
// 审查技术文档。支持四种独立评审类型:大纲评审(检查目录与结构逻辑)、内容评审(检查文字准确性与代码质量)、资产评审(校验链接与引用合规)、格式评审(校对纯视觉排版与标点)。当用户请求审查或修正 Markdown 文档时使用。
Review Agent Skill directories and SKILL.md files against best practices. Use this skill when the user wants to review, validate, or check an Agent Skill implementation.
Use when you want to deeply understand an unfamiliar codebase and generate reusable cognitive skills from it, by providing a local path or GitHub URL
整理和优化项目目录结构。当用户请求整理目录、分类文件、清理无用文件或重构文件夹结构时调用此技能。
检查 Markdown 文件中的本地和外部链接有效性。当用户需要验证、检查 Markdown 文档或项目的链接可访问性时调用此技能。
分析和总结指定的本地 Markdown 文件,并输出结构化的中文总结。当用户请求总结、分析或提取本地 Markdown 文档信息时调用此技能。
将指定的本地 Markdown 文件翻译成指定语言(默认中文),并在文件名中添加语言标识后缀。当用户请求翻译本地 Markdown 文档时调用此技能。
| name | doc-reviewer |
| description | 审查技术文档。支持四种独立评审类型:大纲评审(检查目录与结构逻辑)、内容评审(检查文字准确性与代码质量)、资产评审(校验链接与引用合规)、格式评审(校对纯视觉排版与标点)。当用户请求审查或修正 Markdown 文档时使用。 |
本文档定义了技术文档评审的标准操作规范和检查清单。为了提高评审效率并减少大模型的注意力分散(Attention Dilution),文档评审被拆分为四种独立的评审类型。根据用户的需求,Agent 可以扮演专门的角色,使用对应的专属规则集进行单项审查。
Agent 在执行评审时,应根据用户的指令或文档的实际状态,选择以下某一种或多种类型独立执行。每种类型的评审都应作为一个独立的 Prompt 任务来处理,并输出独立的评审报告。
Agent 在执行特定评审类型时,按需加载对应的详细规则文件:
references/outline-review-rules.md,关注章节安排的逻辑性与合理性。references/content-review-rules.md,关注文字质量、技术准确性和代码逻辑。references/assets-review-rules.md,校验链接、图片、参考文献的有效性与合规性。references/format-review-rules.md,关注纯视觉排版与 Markdown 语法规范。对于任何一种类型的评审,必须按以下标准格式输出评审报告:
## 评审结果 - [评审类型名称]
### 发现的问题
1. **[类别] 行 XX / 第 N 节**:问题描述。
- 建议:具体修改建议或重构示例。
### 总结
共发现 X 个问题。
用户:"帮我进行内容评审,检查 architecture.md 的第 2 节。"
Agent: (触发内容评审规则,加载技术编辑角色)
[内容评审]
发现的问题
- [文字质量] 第 2 节 标题下:缺少概述段落,直接进入了子小节。
- 建议:增加一段关于本节架构核心目标的介绍。
- [一致性] 行 32:术语不一致,前文使用 "KV Cache",此处为 "键值缓存"。
- 建议:统一替换为 "KV Cache"。
总结
共发现 2 个问题。是否需要我为您直接应用这些修改?