用途:统一处理"把项目文档做好"的工作,包括为新项目搭建文档骨架、迭代后刷新文档、撰写能转化读者的 README、以及审计整体文档是否与代码脱节。
主要能力与模式:根据参数进入四种模式。init 从零搭建分级文档;update(默认)在已有 CLAUDE.md 时按代码变更同步;readme 专门撰写或审核 README;audit 做只读的全量文档健康检查。附加 --auto 修饰符可启用自治工作流护栏,需额外加载 auto-update-loop.md。未传模式时按 CLAUDE.md、README.md 是否存在自动判定。
使用方式:通过 $ARGUMENTS 传入模式与参数,如 update 支持 branch、recent [N]、paths <glob>、nested <dir>、pattern <glob>、holistic、dry-run、all。规则文件按需加载(rules/.md),示例在 references/.md,模板在 templates/*.md,不预加载全部。
核心原则:按成本选表面——CLAUDE.md 自动加载、README.md 供人评估、docs/ 按需加载;就近优先,嵌套 CLAUDE.md 只在该子树生效;规定性而非描述性写作;每份文档只服务一个 Diátaxis 象限;不在多个表面重复同一事实;用删除法测试文档必要性。CLAUDE.md 不超过 200 行,rules 放 .claude/rules/ 并配 paths:。
AGENTS.md 跨工具互操作:可用符号链接 ln -s CLAUDE.md AGENTS.md,或让 CLAUDE.md 以 @AGENTS.md 开头共享内容。
限制:每种模式有明确的完成标准,未勾选项视为缺陷;audit 默认只读不改文件;具体收费、平台支持与效果资料暂未提供。