代码文档自动生成

文档和代码不同步时会发生什么

接口改了 README 没更新、注释和实现各说各话、新人只能对着源码猜行为——这类问题在缺少「事实来源」时会被放大。手工维护 API 说明、架构说明和用户指南，成本随模块数量线性上涨，还很难在团队里统一术语和章节结构。

技能在做什么

该技能把角色设定为从代码出发的文档专家：先明确文档类型（API、架构、用户指南、技术参考）和目标读者，再从源码、配置文件和注释里抽取可验证的信息，按一致的结构生成正文。

典型流程包括：

• 梳理待生成产物与文档计划（路径、工具链配置）
• 用统一术语写说明，并考虑接入代码检查或 CI，减少文档与实现漂移
• 在输出中写明假设、缺口和后续任务，方便迭代而不是一次性交差

更细的模板与示例可参考技能包内的 resources/implementation-playbook.md。

适用边界

• 适合：已有可读的代码库，需要 API/架构/用户类文档，或要把文档生成纳入流水线、统一规范。
• 不适合：没有代码或单一事实来源、只要临时口头解释、或无法访问代码与需求——此时无法做可靠的自动化抽取。
• 安全：生成内容中应避免写入密钥、内部 URL 或敏感业务数据。