技术文档自动生成器

## 技能概述

技术文档自动生成器是一款专为开发者设计的 AI 写作技能，能够从源代码的注释、函数签名、类定义等结构化信息中提取关键内容，自动生成符合行业规范的技术文档。无论是 API 参考文档、模块说明还是开发者指南，都能在短时间内高效产出，大幅降低文档维护成本。

## 适用场景

- 为新项目快速搭建初始文档框架
- 从遗留代码中逆向生成说明文档
- 维护 API 参考手册和接口说明
- 生成代码评审配套的设计文档
- 辅助团队新人快速理解代码结构

## 调用步骤

**第一步：提供源代码**
将需要生成文档的源代码片段、文件路径或代码仓库地址发送给 AI。代码应包含必要的注释信息（如 JSDoc、Docstring、Swagger 注解等），以确保生成质量。

**第二步：指定文档类型**
明确告知所需的文档形式，常见类型包括：
- API 接口文档（RESTful 风格）
- 函数/方法参考手册
- 类与模块设计说明
- 整体项目 README
- CHANGELOG 更新日志

**第三步：补充格式要求**
说明输出格式偏好，如 Markdown、HTML、reStructuredText 等，并可指定文档风格（正式、简洁、面向初学者等）。

**第四步：审阅与迭代**
AI 生成初版文档后，开发者可针对具体段落提出修改意见，例如补充示例代码、调整描述详略或修正术语翻译，AI 将根据反馈持续优化输出。

## 支持的编程语言

该技能对以下语言具有较好的识别能力：Python、JavaScript/TypeScript、Java、Go、C/C++、C#、Rust、PHP、Ruby、Swift、Kotlin 等主流编程语言。

## 注意事项

1. **注释质量决定输出质量**：源代码中应包含规范的注释，包括参数说明、返回值描述、异常抛出情况等关键信息。缺乏注释的代码可能导致生成的文档内容不够准确。

2. **敏感信息保护**：在提交代码前，请移除包含密钥、密码、内部域名等敏感信息的注释或字符串，避免泄露。

3. **人工复核不可省略**：AI 生成的文档仅作为初稿，最终发布前应由熟悉代码的开发者进行审校，确保技术细节准确无误。

4. **版本管理建议**：建议将生成的文档与代码一同纳入版本控制系统，保持文档与代码的同步更新。

5. **术语一致性**：对于项目特定术语，建议提前提供术语对照表，确保生成文档中专业词汇的翻译和使用保持统一。

6. **示例代码补充**：自动生成的文档可能缺少完整的使用示例，必要时可要求 AI 补充典型调用场景的代码片段。

7. **长代码分段处理**：对于超大型代码文件，建议按模块或类拆分后分别生成文档，再进行合并整理，以获得更佳效果。