技术文档自动生成
从代码注释到 API 文档到架构图 —— 写完代码文档就出来了
文档这个坑，谁踩谁知道
文档永远跟不上代码
代码改了 20 遍，README 还是三个月前的版本。新人入职看文档，照着跑一遍全是报错，问了才知道"那个文档过时了"。
没人愿意写文档。开发说"代码就是文档"，产品说"你先写我再看"，最后谁也没写，靠口口相传。
好不容易写了一份 API 文档，上线改了两个字段忘了同步，前端同事对着旧文档调了一下午，过来找你算账。
让 OpenClaw 帮你把文档这事给办了
读代码，写文档，保持同步
OpenClaw 直接读你的源代码 —— 函数签名、参数类型、返回值、注释、调用关系，全部分析清楚，然后生成结构化的文档。
不是那种"这个函数接收一个参数"的废话文档。它会写清楚每个接口的用途、参数说明、返回示例、错误码，该有的都有。
代码改了？再跑一次 Prompt，文档自动更新。再也不用担心文档和代码脱节了。
文档生成 Prompt，直接用
从 README 到 API 文档到架构图，三条 Prompt 全搞定。
项目 README 一键生成
新手友好
分析这个项目的完整代码结构，生成一份专业的 README.md。
包含以下章节：
1. 项目简介：一两句话说清楚这个项目干嘛的
2. 功能特性：用 bullet points 列出核心功能
3. 快速开始：安装、配置、运行的步骤（要能直接复制粘贴）
4. 项目结构：目录树 + 每个目录的简要说明
5. 配置说明：环境变量、配置文件的说明
6. API 简要说明（如果有的话）
7. 常见问题
风格要求：简洁清晰，别写废话。示例代码要完整可运行。这条最适合新项目。跑一次就有一份像样的 README，比自己从空白开始写快了十倍不止。老项目也能用，生成后再微调。
API 接口文档生成
黄金指令
读取项目中所有的 API 路由/控制器文件。
为每个接口生成标准的 API 文档（Markdown 格式），包含：
1. 接口路径和请求方法（GET/POST/PUT/DELETE）
2. 功能描述：这个接口干什么用的
3. 请求参数：参数名、类型、是否必填、说明、示例值
4. 请求体示例（JSON 格式）
5. 响应示例：成功和失败的返回值
6. 错误码说明
7. 认证要求（如果需要 token）
按模块分组，加上目录导航。后端开发必备。一个 Prompt 把所有接口文档都生成了，前端同事再也不用追着你问"这个接口参数是什么"了。
项目架构图（Mermaid）
进阶技巧
分析这个项目的完整代码结构和模块依赖关系。
生成以下 Mermaid 图表：
1. 系统架构图（flowchart）：
- 展示主要模块和它们的交互关系
- 标注数据流方向
- 区分前端、后端、数据库、第三方服务
2. 模块依赖图（flowchart）：
- 展示代码模块之间的 import/依赖关系
- 标注核心模块和工具模块
3. 数据流图（sequenceDiagram）：
- 展示一个核心业务的完整请求链路
- 从用户操作到数据库再到返回
每张图附带文字说明，解释关键的设计决策。架构图是最难手画的文档。这条 Prompt 生成的 Mermaid 图可以直接贴到 Notion、GitHub Wiki 或者飞书文档里渲染。
文档生成：OpenClaw vs ChatGPT
都能生成文档，但方式完全不一样。
OpenClaw
- 直接读项目源代码，文档基于真实代码生成
- 理解文件之间的引用关系，API 文档准确完整
- 代码更新后重新生成，文档自动同步
- 支持生成 Mermaid 架构图、时序图
VS
ChatGPT
- 需要手动复制粘贴代码，上下文有限
- 看不到完整项目结构，容易遗漏接口
- 生成的文档是一次性的，代码改了得重新贴
- 大项目代码超出 token 限制，没法一次处理
文档生成的几个窍门
生成 API 文档时，让 OpenClaw 同时生成 Postman/Insomnia 的导入文件，前端同事可以直接导入测试。
如果代码里有 JSDoc、docstring 或 Swagger 注解，在 Prompt 里提一句，AI 会基于这些注释生成更准确的文档。
README 和简单文档用 GPT-4o 就够了，速度快、格式稳。架构分析和复杂依赖关系的文档上 Claude Opus 4.6，理解更深。