Doc Generator

第二步：读取和分析代码

根据目标文件，执行：

1. 用 Glob 工具列出所有目标文件
2. 用 Read 工具读取每个文件的内容
3. 根据 language-patterns.md 的规则，识别语言和提取关键定义

分析时需记录（在脑中维护一个清单）：

• 公共函数列表（名称、参数、返回值）
• 类/模块列表（名称、职责）
• 已有注释的质量（好/需优化/缺失）

第三步：生成文档

根据第一步确定的文档类型，选择对应路径：

路径 A：生成 README

1. 从代码中推断项目名称和核心功能
2. 套用 doc-templates.md 的「模板 C」
3. 遵循 style-guide.md 的写作规范
4. 用 Write 工具写入 README.md

路径 B：生成 API 文档

1. 对每个公共函数/类，套用「模板 A」或「模板 B」
2. 按模块分组，用二级标题区分
3. 遵循 style-guide.md 的写作规范
4. 输出到对话，或用 Write 工具写入 docs/api.md

路径 C：补充 inline 注释

1. 只处理「已有注释质量差」或「缺失注释」的函数
2. 生成符合该语言规范的注释格式（Python 用 docstring，JS 用 JSDoc）
3. 用 Edit 工具修改原文件，插入注释

第四步：质量检查

生成完成后，对照以下清单自查：

• 每个公共函数都有说明
• 参数类型和边界条件都已说明
• 有示例代码（复杂函数必须有）
• 没有废话（对照 style-guide 检查）
• 不确定的地方已标注 ⚠️

异常处理

• 代码逻辑太复杂看不懂：先写能确定的部分，不确定的标注 ⚠️ 待确认，不要猜测后写成事实
• 文件太多（>20个）：先问用户要优先处理哪些，或只处理 export 的公共接口
• 已有文档：先读现有文档，判断是「补充」还是「重写」，不要直接覆盖