用途:在一次操作中同步项目的全部文档文件,通过把各文件交给对应的专用技能来完成,适合初始建立文档或项目发生较大变化后使用,也支持只更新指定文件或只做检查。
主要能力与流程:
- 分析代码库:查看项目类型信号(如 package.json、go.mod、pyproject.toml、Cargo.toml、Dockerfile、*.tf)、当前文档状态、最近提交(git log --oneline -20),以及若为插件市场仓库时的插件数量。
- CLAUDE.md 与 AGENTS.md:运行 doc-claude-md 技能中的脚本 python3 ~/.claude/skills/doc-claude-md/scripts/validate_docs.py --path <project> --fix,用于重新生成目录树、校验 CLAUDE.md、检查 AGENTS.md 结构与代码库一致性并更新 last_validated 时间戳;脚本运行后再手动更新非目录树内容。资料特别提示不要手动编辑 AGENTS.md 的目录树,因其含 tree 命令产生的不间断空格,编辑工具无法匹配,必须用脚本重新生成。
- README.md:委派 doc-readme 技能,创建或更新 README,并与当前代码库状态同步(功能、结构、安装步骤)。
- SKILLS.md:委派 doc-skills-md 技能,分析项目并推荐相关市场插件,创建或更新 Required/Recommended 表格及插件数量;不使用插件市场时可跳过。
- CHANGELOG.md:委派 doc-changelog 技能,根据上次发布或标签以来的 git 历史生成条目,按 Added、Changed、Fixed、Removed 分类,并补充 PR 引用、更新 Unreleased 部分;不维护 CHANGELOG.md 时可跳过。
- 汇总:报告各文件是更新、创建、无变化还是跳过及具体变化。
使用方式:默认全量同步,直接说“更新所有项目文档”;选择性更新时明确点名文件,如“更新 AGENTS.md 和 README.md”;仅校验时读取各文件并与代码库状态对比,报告过期内容但不修改。
限制:资料未提供收费、价格、平台与效果信息;部分步骤依赖项目实际配置(是否使用插件市场、是否维护 CHANGELOG.md),对应步骤可跳过。