让 AI 写文档

README、接口文档、部署说明、使用手册——文档它来写，而且跟着代码走：代码改了文档同步改，不让文档烂尾。

它能写哪些文档

文档	您说
README / 项目说明	「给这个项目写个 README：是什么、怎么跑起来、目录结构」
接口文档	「把用户模块的接口整理成文档，含参数、返回值和示例」
部署说明	「写个部署文档：需要什么环境、怎么启动、注意什么」
使用手册（给使用者看的）	「给这个系统写一份管理员使用手册，按功能分章」
数据库说明	「把表结构和关系整理成文档，画张 ER 图」
变更记录 / 发版说明	「整理这版改了什么，写份发版说明」

怎么开口

跟平时一样说人话，带上下文更好：

给这个项目写一份部署文档，给运维同事看的，
他们不熟这个项目——从环境要求到启动到备份，写全。

两个关键点：

• 说清给谁看——运维、开发者、使用者，深浅口吻完全不同
• 指明详略——「写全」「一页纸」「step by step」它按您的要求控制篇幅

文档落哪、怎么用

• 落在项目文档区（ai-docs/ 下对应目录）或您指定的位置——「放到 docs/ 下面」也行
• Markdown 格式为主：在编辑器里打开即预览，排版所见即所得
• 导出 PDF：说「导出成 PDF」——分发给不看 Markdown 的人（打印、评审、归档）

也要 Word / Excel / PPT？可以

工程文档之外，编程模式同样能直接产出 Office 原生文件——Word 报告、Excel 表格（带活公式）、PPT 演示、PDF：

把这次的性能优化整理成一份 Word 报告，给主管看。

产出的是真文件（.docx / .xlsx / .pptx / .pdf），Office 软件打开可继续编辑。完整走法见 FDE 教程 Office 文档怎么做——能力是同一套，两边用法一致。

最值钱的一点：文档跟着代码活

单次写文档不稀奇，稀奇的是改代码时文档同步更新：

（它刚把用户模块加了「冻结」状态）
——您会在交付说明里看到：已同步更新接口文档与数据库说明

项目的需求、设计、接口文档都在 ai-docs/ 体系里随开发维护——这是它的常态工作方式（这套机制详见项目文档机制），您只需要在验收时确认文档真的更新了（没更新就说「文档同步一下」）。

写文档的进阶玩法

「把这次的改动整理成一份技术方案文档，给架构评审用」
「对照代码，检查现有文档有没有过时的地方，列出来」
「把接口文档翻译成英文版」
「把这份 50 页的设计文档浓缩成一页纸给老板看」

常见卡点

现象	怎么办
文档太技术了看不懂	「写给不懂技术的人看」——它换口吻重写
内容与代码对不上	「对照最新代码核对一遍这份文档」——它逐节核对并修正
想要固定格式 / 模板	把模板文件给它：「照这个模板写」
表格 / 图有吗	有——表格直接写；流程图、ER 图直接配（见画流程图与图表）
文档写好了放哪了	问它「刚才的文档落在哪」——或翻文件树 ai-docs/ 与 docs/

延伸阅读

• 项目文档机制：ai-docs/ 这套「活文档」体系怎么运转
• 画流程图与图表：文档里配图的出法
• 让 AI 改代码：代码与文档同步更新的另一半