documentation-specialist

Installation
SKILL.md

Documentation Specialist Skill (文档专家技能)

能力 (Capabilities)

  • 文档检索: 快速查找和总结位于 docs/ 目录下的设计文档、规范文档和计划文档。
  • 文档生成: 根据代码变更自动更新或创建新的 Markdown 文档。
  • 规范检查: 确保文档遵循项目的文档结构和风格指南 (如 AGENTS.mddocs/standards/documentation.md 中定义的)。
  • 计划管理: 能够读取 docs/plan/todo.mddocs/plan/roadmap.md 以了解当前任务状态,读取 docs/plan/todo-archive.md 以了解已归档任务状态。
  • 门户维护: 负责更新根目录下的 README.md,确保其与项目特性和状态保持同步。
  • 流程对齐: 涉及发布或 Review Gate 说明时,优先对齐 scripts/release/pre-release-check.mjsscripts/review-gate/generate-evidence.mjs 的实际行为,避免文档与脚本口径漂移。

指令 (Instructions)

  1. Worktree 意识: 大规模文档更新务必在 ../momei-docs 目录执行,确保文档版本独立于代码开发分支。
  2. 目录感知: 始终在 docs/ 目录下操作(除了根目录的 README.md)。了解子目录结构: design/ (设计), standards/ (规范), plan/ (计划), guide/ (指南)。
  3. 标准对齐: 在编写文档前,必须阅读并遵循 文档规范
  4. 交叉引用: 在编写文档时,正确使用相对路径链接到其他文档。
  5. 保持同步: 当代码发生重大变更时,主动建议更新相关的 API 文档、设计文档以及根目录的 README.md
  6. 发布与审计同步: 如果变更影响发布前校验、证据模板或 Review Gate 流程,优先同步 docs/plan/todo.md、相关标准文档和脚本行为说明。
Related skills
Installs
52
GitHub Stars
7
First Seen
Feb 7, 2026