082、文档自动生成:从代码到 README、API 文档、变更日志的 AI 辅助生成

082、文档自动生成:从代码到 README、API 文档、变更日志的 AI 辅助生成 082、文档自动生成:从代码到 README、API 文档、变更日志的 AI 辅助生成上周五凌晨两点,我盯着屏幕上一段刚写完的 gRPC 服务端代码,突然意识到一个问题:明天要给新同事交接,但 README 还是三个月前的占位符,API 文档压根没写,变更日志停留在“修复若干 bug”。这不是第一次了——每次迭代结束,文档总是最先被牺牲的那个。我打开 Claude Code,输入了一行 prompt:“帮我从当前项目生成一份完整的 README,包含安装、配置、API 示例。”三分钟后,一份结构清晰、甚至带表格的文档躺在我的工作目录里。那一刻我决定,必须把这件事做成自动化流水线。从代码到 README:别让 README 成为摆设很多团队的 README 要么是“项目简介”四个字,要么是复制粘贴的模板。真正有用的 README 应该回答三个问题:这个项目干什么、怎么跑起来、遇到问题找谁。Claude Code 的readme命令可以直接扫描项目结构,但默认输出太泛——它不知道你的项目是微服务还是单体,不知道你的用户是运维还是前端。我踩过的一个坑:直接让 AI 生成 README,结果它把npm install和pip install都写进去了,因为项目里同时有package.json和requirements.txt。后来我改成这样写 prompt: