参考文档构建器

要解决什么问题

团队维护 API、配置项或数据模式时，常见问题不是「有没有文档」，而是查不到、对不上、缺边界：参数表不全、默认值与实现不一致、错误码散落各处，新人要在代码和 Wiki 之间来回跳。参考文档若不能作为单一事实来源，评审和联调成本会持续抬高。

技能如何工作

本技能把角色定位为参考文档专家，按可检索的参考结构组织内容，而不是写长篇教程。

核心能力包括：

• 全面覆盖：记录公共接口上的参数、方法、配置项
• 精确分类：概述 → 快速参考 → 详细参考 → 高级主题 → 附录
• 交叉引用：概念、依赖与相关条目互链
• 示例与边界：最小可运行示例，以及限制、弃用与异常路径

构建流程可概括为：盘点公共接口 → 从代码/规范提取 → 补示例与上下文 → 对照实现验证 → 优化检索结构 → 建立交叉引用。输出以 Markdown 为主，并可在合适处配合表格、警告块（警告/注意/已弃用/安全）与机器可读元数据（如 OpenAPI、JSON Schema）。

适用边界

• 适合：API 参考、配置指南、模式/字段文档，以及快速入门、故障排除、版本迁移等查阅型章节。
• 不适合：与参考文档无关的任务，或需要另一套工具链/领域方法论的工作流；此时应换用对应技能而非强行套用本清单。

使用时需先明确目标、约束与输入来源；细节示例见技能包内 resources/implementation-playbook.md。