用途
doc-standards 用于在代码仓库中编写、移动、审阅或审计文档时,应用仓库自身的文档标准。该标准通常位于仓库的文档标准文件中(典型为 docs/AGENTS.md)。此技能覆盖文档的放置、语料库审计、字数预算以及跨 Markdown、JSDoc 和代码注释的校验。它是指导性流程,不是脚本;需要结合仓库的 prose-standard 进行必需覆盖判断和编辑判断,且不能仅把长度当作缺陷。
主要能力
- 依据仓库文档标准确定文档层级、教程与参考形式、分类法、预算和 slop 检查清单。
- 在修改文字前先审阅结构:定位文档在仓库和导航树中的位置,说明其自身主题并识别直接子项,设定允许的详细程度。
- 按预期用途而非路径或标题对文档分类:教程必须引导有序工作并达到可观察结果;参考文档必须在明确范围内支持查阅,不要求顺序阅读。
- 对教程私下分类起始读者和概念为初级、中级或高级,追踪每个概念的前置条件,重排过早出现的材料,将可选的高级细节移到后续教程或参考文档。
- 拆分实质性的混合形式,将小的次要形式放在清晰标注的章节中。
- 检查使放置代价高昂或错误的约束:配对文档每次编辑都需要更新对应方并重新记录;生成目录从不手工编辑;重命名或移动文档前用 grep 检查入站引用,包括 Markdown 链接目标和 #fragment 锚点、代码注释中的 docs/*.md 引用;移动是原子操作,需在同一变更中移除旧位置、添加新位置并修复所有入站链接。
- 审计语料库:先用最便宜的探针查找标准中的 slop 检查清单;验证并获取实时基线;运行仓库的变更范围工具(若存在)识别已提交和脏路径;测量预算门禁并用 git ls-files '*.md' ':(exclude)vendor/**' | xargs wc -w | sort -rn | head -30 发现未预算的异常值。
- 查找推理过程泄漏:叙述性历史、已失效的设计会话引用、审阅编排、控制流叙述、测试走查,使用 trim-cot-leakage 定义的分类法、召回测试和保留或删除规则。只保留非显而易见的契约或持久理由;同一理由在兄弟方法旁重复时只保留一个位置。
- 通过 grep 独特短语查找重复内容,保留一个位置并用链接替换其他副本。
- 用权威树、脚本或生成参考替换手写目录、测试/状态清单和 JSDoc 复述。
- 在 implemented/ Agent Notes 中移除迁移计划、验收任务清单和未来时态规范语言,保留简洁的验证契约和命名的覆盖缺口。
- 如果移除文字会改变承诺的行为而非其解释,先使用提议的 Agent Note(遵循 find-simplifications)。
- 将冻结的归档 Agent Notes 排除在语料库审计和编辑之外;活跃文字可以修复、重定向或删除入站链接,但绝不跟随归档范围的清理进入冻结目标。
- 保留每条承重规则,最好是一到三行加上指向其理由的链接;删除故事、重复、状态说明和推导规则的路径;不要仅为迁移可丢弃的推理而创建新解释。
- 当文档预算门禁变红时,应用仓库文档标准中的有序迁移-精简-提高策略;此技能只提供上述工作流探针。
- 验证与 PR 卫生:至少运行仓库的文档门禁、lint 和 git diff --check;JSDoc 变更可能重新生成目录;如果配对文档变更,遵循仓库的轻量配对例程并用配对门禁的写入标志重新记录;PR 正文应给出字数增量、解释任何故意过长的例外并列出检查项。
使用方式
该技能作为指导性工作流使用,需结合仓库自身的文档标准、Agent Note 规则、事后复盘规则、双语配对契约和根 AGENTS.md 的常设命令。它不提供独立脚本,而是定义审阅和审计的步骤与探针。
适用场景
适用于在代码仓库中编写、移动、审阅或审计文档的场景,包括 Markdown、JSDoc 和代码注释。特别适合需要应用文档标准、进行语料库审计、控制文档预算、检查配对文档和入站引用的仓库维护工作。
限制
该技能是指导而非脚本,不能替代仓库自身的文档标准。它不提供具体的收费、价格、平台或效果信息。部分细节(如仓库特定的门禁工具、配对门禁标志、变更范围工具)取决于具体仓库是否提供,资料中未给出通用实现。