通用专题 · 02 · 方法论
AI 帮你写完
所有文档
程序员最讨厌写文档。AI 在文档上是真·神器 — 30 秒出能看的初稿，5 类文档 prompt 直接抄。Claude / GPT / Cursor 通用。
为什么用 AI 写文档
程序员最讨厌写文档 — 但文档不写，老项目交接 / 团队协作 / SEO 都受罪。AI 写文档恰好补了这块短板：你只要把代码丢给它，30 秒出一份能看的初稿。
AI 写文档的甜区：
- 初稿质量 70% · 比从零写省 90% 时间
- 能跟代码同步更新（每次大版本重跑）
- 语气可以一致（设置好风格 prompt 就稳了）
5 类文档 · 直接抄 prompt
1 · README
项目入门文档
新人看 5 分钟就能装好跑起来的 README — 项目目的 / 安装 / 快速开始 / 常用命令。
读完整个仓库后给我写一份 README.md。结构：① 一段话项目介绍 ② 3 个核心功能 ③ 安装步骤（按 Mac/Win/Linux 分） ④ 快速开始（3 个最常用命令） ⑤ 目录结构图。语气专业但不冗长，不超过 200 行。
2 · API 文档
给开发者看的接口文档
扫一遍 API 代码，自动出每个端点的入参 / 出参 / 示例 / 错误码。
扫一遍 src/api/ 下所有路由，给我生成一份 API.md。每个端点包含：路径 + 方法 + 描述 + 入参 schema + 出参 schema + curl 示例 + 常见错误码。优先用 OpenAPI 风格但 markdown 表达。
3 · 技术规范
新功能的 Tech Spec
需求文档 / Issue 描述 → 技术方案。让 AI 帮你拆架构。
需求：「给用户头像加上传功能」。读完现有代码后给我写一份 Tech Spec：① 影响哪些模块 ② 数据库变更 ③ API 设计 ④ 前端组件 ⑤ 风险点。500 字以内，不要纸上谈兵。
4 · CHANGELOG
从 git log 整理变更日志
每个版本发布前的固定动作，AI 比手动整理快 10 倍。
看从 v1.2.0 到 HEAD 的 git log。按 Keep a Changelog 规范输出 CHANGELOG · v1.3.0 段。分类：Added / Changed / Fixed / Removed。每条不要超过一行。merge commit 跳过。
5 · 用户手册
给非技术用户看的说明
跟 README 不同 — 这是给「不会 git clone」的用户看的，强调场景和步骤。
读完整个产品后写一份用户手册（manual.md）— 受众是不懂代码的普通用户。按「想做什么 → 怎么做」组织，5 个最常见场景每个一节，配步骤截图位（用 [截图：xxx] 占位）。中文，亲切口吻。
让 AI 写得稳的 4 条心法
① 给受众 · 「给新人」「给开发者」「给运营」结果完全不同
② 给参考 · 「按这个项目的现有风格」/ 贴一个范例文件给它对齐
③ 给长度限制 · 「不超过 200 行」/「500 字以内」否则 AI 会写出小说
④ 跑两轮 · 第一轮出大纲，第二轮按大纲填充。中间你审一下结构再放手
在哪个工具里跑最好
命令行
Claude Code / Codex CLI
读整个仓库 + 写整份文档
推荐
- 能自动扫多文件
- 能写 + 保存
- 大型仓库首选
IDE 内
Cursor Composer
边看代码边写文档
直观
- 选中代码 + 让它写
- diff 直接看
- 中小项目方便
网页
ChatGPT / Claude.ai
手贴代码 + 让它写
单文件
- 不用装客户端
- 不能自动扫仓库
- 单文件文档适合
3 个常见踩坑
AI 文档里出现没有的功能 · LLM 幻觉。每个 README 命令都要自己跑一遍验证
文档跟代码不一致 · AI 只看到一半代码。把所有相关文件都提到 prompt 里
风格漂移 · 没给参考。贴一个范例文档让它对齐风格
FAQ
哪个模型写文档最好
Claude Sonnet 中文最自然，写 README / 用户手册首选。GPT-5 / o3 适合技术规范（推理强）。DeepSeek V3 性价比之王，中文也很好。
大仓库怎么让 AI 看全
Claude Code / Codex CLI 在终端跑，可以自动遍历。Cursor Composer 用 `@` 加文件引用。最差的方法是手贴代码到网页 — 这只能搞单文件。
能不能让 AI 同步更新
能。配 git hook，每次 commit 跑一次「检查 README / API.md 跟代码是否一致，不一致就更新」。这是 教程 general-05 · AI + Git 的内容。
下载暴喵 AI 管家
一站装好 Claude Code / Cursor / Codex CLI · 写文档第一步