用途
sync-docs 用于在代码发生变更后,检查项目文档是否与代码保持一致,帮助判断哪些文档需要更新。当用户说出「sync docs」「文档同步」或「检查文档」时触发。
主要能力
该技能会检查最近的代码变更(git diff HEAD~5 --name-only),扫描项目的文档体系,并报告需要更新的内容。检查清单项会根据项目中实际存在的目录来检测,具体包括:
- 知识库:判断 docs/knowledge/ 中是否有新的经验需要记录。
- 实验登记表:判断是否有新实验已登记到登记表中。
- 项目指令:判断 CLAUDE.md 的索引表是否覆盖了所有知识文件。
- 规则:判断是否有新的硬性约束需要在 .claude/rules/ 中固化。
- README:判断项目 README 是否与当前代码结构一致。
- 策略文档(仅在 docs/strategy/ 存在时):判断愿景、路线图或论文大纲是否反映了最近的变更。做法是比对 git log 活动与策略文档的最后修改日期,标记在 5 次以上相关代码变更后仍未更新的文档。可配合 /project-review 进行完整的策略分析。
使用方式
当用户说出「sync docs」「文档同步」或「检查文档」时触发该技能。技能会输出一份清单,将每个检查项标记为「需要更新」或「已是最新」。
适用场景
适用于在代码提交后需要确认文档同步状态的开发工作流,尤其是维护了知识库、实验登记表、项目指令、规则、README 或策略文档的项目。
限制
该技能仅做报告,不会自动修改任何文件(Report only — do NOT auto-modify)。其他功能细节、收费、价格、平台等信息暂未提供。