Documentation Builder

Documentation Builder 是一项专门的代理技能，旨在弥合技术实现与开发者体验之间的差距。它针对需要高质量、最新文档而无需维护开销的软件工程师、技术文案和项目负责人。通过深入分析您的代码库、路由定义和基础设施设置，该技能可以创建符合您特定技术堆栈的结构化参考资料。它在 Flask、React 或微服务架构等环境中表现出色，这些环境中同步 API 规范、数据流图和入职指南通常非常耗时。

• 自动提取 API 签名、请求/响应模式和身份验证协议，以生成 OpenAPI/Swagger 规范。

• 生成全面的架构概览，包括组件关系映射、系统边界和技术堆栈说明。

• 产生多格式输出，包括用于版本控制的 Markdown、用于网页托管的 HTML 以及用于正式发行的 PDF。

• 自动创建语言特定的代码示例（Python、JavaScript、Go、Java、cURL），以促进开发者采用。

• 构建教学性用户指南，包括设置教程、环境配置步骤和针对新项目贡献者的故障排除部分。

• 为数据管道、序列流和部署拓扑执行自动图表生成，以可视化复杂的系统逻辑。

• 在输入中提供特定上下文，例如身份验证方法 (JWT, OAuth) 或特定的 API 约束，以确保生成的文档在技术上准确。

• 在迭代开发周期中使用此技能，使文档与新功能部署同步，确保入职材料保持相关性。

• 当与清晰的代码注释配对时，输出效果最佳，因为该技能会解析现有的代码结构以推断意图和文档部分。

• 尽管该工具高度自动化，但建议人工审查架构图，以确保系统边界符合组织标准。

• 输入要求包括访问您的存储库结构和任何相关技术规范；输出产物已针对 GitHub、GitBook 以及标准静态站点生成器（如 Docusaurus 或 MkDocs）进行了优化。