doc-reviewer
文档评审
本文档定义了技术文档评审的标准操作规范和检查清单。为了提高评审效率并减少大模型的注意力分散(Attention Dilution),文档评审被拆分为四种独立的评审类型。根据用户的需求,Agent 可以扮演专门的角色,使用对应的专属规则集进行单项审查。
1. 评审类型
Agent 在执行评审时,应根据用户的指令或文档的实际状态,选择以下某一种或多种类型独立执行。每种类型的评审都应作为一个独立的 Prompt 任务来处理,并输出独立的评审报告。
- 大纲评审 (Outline Review)
- 角色:结构架构师 (Structure Architect)
- 动作:仅提取文档的所有标题(TOC),对文档骨架进行全局审视。发现结构问题并提供重构建议。
- 内容评审 (Content Review)
- 角色:技术编辑 (Technical Editor)
- 动作:将文档按章节(或子小节)切块,逐个 Chunk 深度阅读。专注于文字质量、技术准确性和代码逻辑。
- 资产与链接评审 (Assets & References Review)
- 角色:合规与资产巡检员 (Compliance & Asset Inspector)
- 动作:提取所有超链接、图片路径、文件引用和参考文献进行批量检查。确保外部依赖有效且合规。
More from forceinjection/awesome-skills
agent-skill-reviewer
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.
5project-analyzer
Generate a comprehensive project documentation (whitepaper) based on deep codebase analysis, covering architecture, modules, testing, and deployment.
4dir-organizer
整理和优化项目目录结构。当用户请求整理目录、分类文件、清理无用文件或重构文件夹结构时调用此技能。
4code-reader
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
4md-summarizer
分析和总结指定的本地 Markdown 文件,并输出结构化的中文总结。当用户请求总结、分析或提取本地 Markdown 文档信息时调用此技能。
4update-submitter
Analyzes git status, groups related file changes, and generates standardized Conventional Commits. Invoke when the user wants to commit changes, submit updates, or create a PR.
3