用途:集中处理“把项目文档写好”的工作,覆盖智能体热路径(CLAUDE.md、AGENTS.md、.claude/rules/)、人类入口(README.md)与叙述层(docs/)。适用于新项目初始化、迭代后刷新文档、撰写可转化读者的 README,或对整套文档做漂移审计。SKILL.md 本身只是索引,详细规则在 rules/.md 按需加载,示例在 references/.md,脚手架骨架在 templates/*.md。
主要能力与模式:
- init:从零搭建分层文档,检测已有配置、复杂度、技术栈,生成对应层级文件并写入 .gitignore。
- update:默认模式,对比分支与默认分支或最近 N 次提交,检测文档漂移并定向修复,支持 paths、nested、pattern、holistic、dry-run、all 等参数与子模式。
- readme:根据上下文进入脚手架模式或审计模式,按 standard-readme 规范生成或评分 README。
- audit:默认只读,盘点全部文档文件并逐面审计,输出 P0/P1/P2 优先级报告。
使用方式:以模式词(init、update、readme、audit)作为第一个参数调用;追加 --auto 启用自主工作流护栏。未传模式词时按 CLAUDE.md 与 README.md 是否存在自动判定。每次运行先加载 rules/content-routing.md、rules/placement-resolver.md、rules/writing-style.md,再按模式加载对应规则。
限制与原则:CLAUDE.md 不超过 200 行;README 首屏需回答“这是什么、能否解决我的问题、是否可信”;同一事实不在各文档面之间重复,只保留一个归属方并从其他处链接;嵌套规则放最内层 CLAUDE.md 以节省 token;文档按 Diátaxis 单一象限拆分。AGENTS.md 为跨工具规范,可用 ln -s CLAUDE.md AGENTS.md 建立符号链接,或让 CLAUDE.md 以 @AGENTS.md 开头做 @import。具体价格、平台与执行效果资料暂未提供。