技术文档生成助手

## 功能概述

技术文档生成助手是一款专注于从源代码中自动提取信息并生成专业文档的AI技能。它能够解析代码注释、函数签名、类结构、参数定义等关键信息，输出符合行业规范的Markdown格式文档。该工具支持主流编程语言，包括Python、JavaScript、Java、TypeScript、Go、Rust等，能够满足不同技术栈开发者的文档编写需求。

## 核心能力

### 智能信息提取

- 自动识别并提取JSDoc、Docstring等标准化注释格式
- 解析函数和方法的签名信息，包括参数类型、返回值类型
- 识别类和模块的结构关系
- 提取常量、变量、枚举等定义信息

### 多格式输出

- 生成符合行业标准的API文档
- 输出详细的使用示例代码
- 创建参数说明表格
- 生成变更日志和版本说明

### 多语言支持

支持的语言包括但不限于：
- Python (Google/NumPy/Sphinx风格注释)
- JavaScript/TypeScript (JSDoc)
- Java (Javadoc)
- Go (godoc)
- Rust (doc comments)
- C/C++ (Doxygen)

## 适用场景

1. **项目初始化阶段**：为新项目快速生成基础文档框架
2. **代码审查期间**：自动生成文档草稿供人工审核
3. **开源项目发布**：为GitHub仓库创建规范的README和API文档
4. **团队协作开发**：统一文档格式，提升代码可维护性
5. **技术交接工作**：快速生成现有代码的技术说明文档

## 调用步骤

### 第一步：准备源代码

将需要生成文档的源代码复制到剪贴板。推荐包含：
- 完整的函数或方法定义
- 相关的注释说明
- 类型注解（如有）

### 第二步：触发技能

当需要生成文档时，明确告诉AI助手：
- "请为以下代码生成技术文档"
- "生成API文档"
- "创建代码使用说明"

### 第三步：粘贴代码

将准备好的源代码粘贴到对话中，等待AI处理。

### 第四步：审阅输出

检查生成的文档内容，包括：
- 信息准确性
- 格式规范性
- 示例代码完整性
- 是否有遗漏的关键信息

### 第五步：请求修改

如需调整，可以提出具体要求：
- "请添加更多使用示例"
- "参数说明需要更详细"
- "调整为中文文档"

## 注意事项

### 代码质量依赖

生成的文档质量直接依赖于源代码的注释质量和结构清晰度。建议：
- 使用标准化的注释格式
- 为复杂逻辑添加详细说明
- 保持命名的一致性和可读性

### 信息完整性

- 注释缺失的代码可能生成不完整的文档
- 私有方法和内部实现默认不包含在公共API文档中
- 建议对生成内容进行人工审核和补充

### 格式规范

- 输出默认采用Markdown格式
- 表格形式展示参数信息
- 代码块使用对应语言的语法高亮
- 标题层级遵循标准文档规范

### 敏感信息处理

- 避免在代码中包含密码、密钥等敏感信息
- 如有需要，在生成文档前进行脱敏处理
- API文档应聚焦于公共接口，不暴露内部实现细节

### 版本兼容性

- 生成文档时请注明目标代码版本
- 不同版本间API变化应单独说明
- 建议配合版本管理工具使用

## 输出示例

典型的文档输出包含以下部分：

- **模块/类简介**：功能说明和主要用途
- **函数签名**：完整的定义信息
- **参数表格**：名称、类型、必填、说明
- **返回值说明**：类型和含义
- **使用示例**：可运行的代码片段
- **注意事项**：使用限制和最佳实践
- **相关链接**：关联的函数或参考资料

通过遵循以上指南，开发者可以高效地利用技术文档生成助手创建专业、规范的项目文档，提升开发效率和代码可维护性。