docs-governance 是 Cherry Studio 仓库使用的文档治理技能,面向仓库文档的撰写、重构、审计与评审。其适用对象包括 README、JSDoc、代码注释、Agent 指令以及成对的中英翻译文档。
一、作用范围与前置阅读 使用该技能时必须先声明明确的处理范围。在评判文字表述之前,需要先阅读适用的 AGENTS.md,再阅读负责该主题的源文件或模块 README,以此作为判断依据。
二、事实的归属位置 技能规定不同类型的信息应放在固定位置:
- 跨领域、跨模块的行为放在 docs/references/<domain>/ 下;
- 仓库流程类内容放在 docs/contrib/ 下;
- 模块私有行为放在模块旁边;
- 长期保留的理由与被否决的替代方案放在 Agent Notes 中;
- Agent 常驻指令放在最窄适用的 AGENTS.md 中,并链接其理由。 同时坚持每个事实只保留一个权威出处:领域 README 拥有其主题,通过链接汇总子文档,而不复制子文档的实现细节;教程按顺序引导操作直至可观察结果;参考文档用于查询并描述当前行为。
三、检查代码变更影响 需要运行 pnpm change:scope --base <verified-ref> 和 pnpm docs:affected --base <verified-ref>,并对照变更后的行为逐一检查返回的每份文档。源文件前缀匹配只是必须触发评审的提示,并不证明文字需要改动。参考文档应描述当前实际情况,保留行为、失败、时序、归属、模态、例外与后果;应删除实现过程叙述、推理记录、评审历史、重复理由、状态清单,以及已有源文件或生成器负责维护的目录。
四、生成文档与配对文档 参考文档需带有 description 和 sources,contrib 与治理类文档需带有 description。禁止手工编辑 docs/README.md、docs/sources-index.json 和 docs/i18n/terminology.md。对于范围内的配对文档,需先阅读配对约定、翻译规则与术语表,对对应文档做最小更新,并在语义评审后重新记录;新增配对或批量翻译使用 translate-docs。
五、验证方式 仅涉及文档的改动运行 pnpm docs:check。涉及脚本、钩子、代码注释或技能变更时,还需按适用情况运行聚焦测试、pnpm lint、pnpm test:lint 和 git diff --check。
六、适用场景与限制 该技能适用于在 Cherry Studio 仓库内维护文档质量与一致性的场景。技能文档未提供收费、价格、平台支持范围或效果数据等信息,这些内容暂未提供。