学习目标：掌握使用AI生成高质量代码文档、API文档和技术文档的Prompt技巧 预计时长：85分钟 前置知识：完成第七课（代码生成Prompt）

课程架构图

一、引言：为什么文档生成需要专门的Prompt技巧？

1.1 文档的重要性

"代码是写给机器的，文档是写给人的。"

1.2 AI文档生成的价值

传统文档编写:
理解代码 → 编写文档 → 格式调整 → 示例补充 → 审查修改
  慢       繁琐          耗时        耗力        反复

AI辅助文档生成:
提供代码 → AI生成 → 人工审查 → 轻微调整 → 发布
  快       自动          高效        简单        一致

三大价值：

1. 效率提升 - 从代码到文档自动化
2. 质量一致 - 统一的格式和风格
3. 维护便利 - 代码变更时快速更新文档

1.3 文档生成Prompt的核心要素

┌─────────────────────────────────────────────┐
│        文档生成Prompt的五大要素               │
├─────────────────────────────────────────────┤
│  1. 代码上下文                               │
│      完整的函数/类/端点代码                  │
├─────────────────────────────────────────────┤
│  2. 文档风格                                 │
│      Google/NumPy/Sphinx等格式               │
├─────────────────────────────────────────────┤
│  3. 内容要求                                 │
│      参数、返回值、异常、示例等               │
├─────────────────────────────────────────────┤
│  4. 目标读者                                 │
│      开发者、集成者、最终用户                 │
├─────────────────────────────────────────────┤
│  5. 特殊说明                                 │
│      注意事项、最佳实践、安全警告             │
└─────────────────────────────────────────────┘

二、代码文档生成

2.1 Docstring风格选择

主流Docstring风格：

2.2 函数Docstring生成Prompt

基础模板：

为以下函数生成docstring：

```python
def function_name(param1: type1, param2: type2) -> return_type:
    """[简短描述]"""
    [函数体]
```python

要求：
1. 使用[风格]格式（Google/NumPy/Sphinx）
2. 简洁描述函数功能（一句话）
3. 列出所有参数：
   - 参数名
   - 参数类型
   - 参数说明
4. 说明返回值：
   - 返回类型
   - 返回值描述
5. 列出可能抛出的异常（如有）
6. 包含一个实际的使用示例
7. 添加任何重要的注意事项

2.3 实战示例：函数文档

待文档化代码：