自动文档生成

文档和代码脱节时会发生什么

接口改了 README 没更新、架构图停留在上个季度、新人只能靠读源码猜行为——这类问题往往不是「没人写文档」，而是文档没有和代码共用事实来源。一旦文档靠手工维护，就会在版本节奏下持续漂移，评审时也缺少可对照的产出清单。

技能在做什么

本技能把角色设定为文档专家：从代码、配置与注释里抽取信息，再按目标受众生成 API 说明、架构说明、用户指南或技术参考，并尽量统一术语与章节结构。

典型工作流可以概括为：

• 先定类型与读者：明确要产出哪类文档（API / 架构 / 用户向），以及谁会是主要读者。
• 从仓库提取事实：扫描代码路径、配置与注释，避免凭印象写「理想架构」。
• 生成并保持一致性：用同一套术语与模板输出，减少不同文档之间的说法冲突。
• 接入自动化与校验：在 CI 或 lint 流程里检查文档是否仍与代码对齐；需要模板与示例时可参考 resources/implementation-playbook.md。

输出侧会给出文档计划与产物、文件路径与工具配置，以及假设、缺口与后续任务，方便你按项补齐而不是一次性「写完就忘」。

适用边界

• 适合：已有可访问的代码库或配置作为来源；需要 API / 架构 / 用户文档，或要搭文档流水线、在全库统一文档规范。
• 不适合：没有代码或权威需求说明；只要临时口头解释；无法访问代码与需求材料。
• 安全：生成内容时避免写入密钥、内部 URL 或敏感数据。