关于 documentation-specialist
面向 MomeiBlog 项目的文档维护技能，帮助团队检索、编写和校验 Markdown 文档。它还关注文档规范、计划状态及发布和 Review Gate 说明与脚本行为的一致性。
主要功能
- 01检索并总结项目文档
- 02根据代码变更更新文档
- 03检查文档结构与风格规范
- 04读取并维护计划状态
- 05同步根目录 README.md
- 06对齐发布与 Review Gate 说明
适用场景
- 01查找 API 或设计规范
- 02为代码变更补充接口文档
- 03更新路线图或待办状态
- 04同步发布校验流程的文档说明
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/documentation-specialist确认已加载。
详细介绍
来自项目 READMEDocumentation Specialist Skill (文档专家技能)
能力 (Capabilities)
- 文档检索: 快速查找和总结位于
docs/目录下的设计文档、规范文档和计划文档。 - 文档生成: 根据代码变更自动更新或创建新的 Markdown 文档。
- 规范检查: 确保文档遵循项目的文档结构和风格指南 (如
AGENTS.md和docs/standards/documentation.md中定义的)。 - 计划管理: 能够读取
docs/plan/todo.md和docs/plan/roadmap.md以了解当前任务状态，读取docs/plan/todo-archive.md以了解已归档任务状态。 - 门户维护: 负责更新根目录下的
README.md，确保其与项目特性和状态保持同步。 - 流程对齐: 涉及发布或 Review Gate 说明时，优先对齐
scripts/release/pre-release-check.mjs与scripts/review-gate/generate-evidence.mjs的实际行为，避免文档与脚本口径漂移。
指令 (Instructions)
- Worktree 意识: 大规模文档更新务必在
../momei-docs目录执行，确保文档版本独立于代码开发分支。 - 目录感知: 始终在
docs/目录下操作（除了根目录的README.md）。了解子目录结构：design/(设计),standards/(规范),plan/(计划),guide/(指南)。 - 标准对齐: 在编写文档前，必须阅读并遵循 文档规范。
- 交叉引用: 在编写文档时，正确使用相对路径链接到其他文档。
- 保持同步: 当代码发生重大变更时，主动建议更新相关的 API 文档、设计文档以及根目录的
README.md。 - 发布与审计同步: 如果变更影响发布前校验、证据模板或 Review Gate 流程，优先同步
docs/plan/todo.md、相关标准文档和脚本行为说明。 - 格式规范: 使用标准的 Markdown 格式。对于图表，使用 Mermaid 语法。
- 读取优先: 在回答有关“如何做”的问题时，优先查阅
docs/standards/下的规范文档。 - 站点维护: 涉及目录结构变更时，应同步考虑更新
docs/.vitepress/config.ts中的导航和侧边栏配置。
使用示例 (Usage Example)
输入: "查阅 API 设计规范关于状态码的定义。"
动作: 读取 docs/standards/api.md 并提取状态码部分。
输入: "更新 API 文档以包含新的文章发布接口。"
动作: 读取 server/api/posts/index.post.ts 的代码逻辑，然后在 docs/design/api.md 中添加对应的接口描述。
评论
支持 Markdown