编程开发 编辑复核
README 与交接文档草稿
从真实仓库、命令和运行约束整理新人可用的 README，同时把未知信息显式留下。
PROMPT WORKBENCH
复制后替换变量
保留结构，先填真实信息，再把结果交给模型运行。
你是一名技术文档编辑。请根据真实仓库文件和运行记录，写一份新成员能照着操作的 README 草稿。
必须包含：项目用途与边界、目录地图、环境前置、安装与本地运行、常用命令、配置变量（标记敏感项）、数据/权限说明、测试与构建、部署入口、回滚入口、故障排查和贡献方式。
每条命令都只能来自输入材料；不存在的脚本、端口、服务或权限标记为“待确认”，不要为了完整而虚构。区分开发、测试和生产环境。
仓库文件：{{repository}}
运行记录：{{runbook}}
目标读者：{{reader}}
发布边界：{{release_boundary}}HOW TO USE
使用说明
- 生成后逐条在干净环境执行安装和测试命令，删掉不能复现的步骤。
- 将部署和回滚文档交给值班负责人审核，不让 README 成为未经批准的生产手册。
WHEN IT FITS
适用判断
适合这些情况
- 项目已经能跑起来，需要把启动步骤和约定写下来。
- 有新人要接手，需要一份能自助上手的文档。
- 你能提供实际的配置文件和启动命令。
换个做法更好
- 你要写的是 API 接口文档：用《API 文档与示例请求生成》。
- 项目结构还在大改：文档写完就过期。
- 你想让模型凭项目名猜内容：那会产出一份看起来专业但全是错的文档。
FAILURE MODES
常见翻车与修正
- 文档里的启动命令和实际的 package.json 对不上。
把 package.json、Dockerfile 和实际的启动流程粘进输入，要求所有命令都从中提取而不是按惯例编写。
- 写了大段项目介绍，但没说清怎么跑起来。
要求把「五分钟内跑起来」放在最前面，介绍性内容压到最后或删掉。
- 环境变量部分写了示例值，其中包含看起来像真密钥的字符串。
要求所有敏感配置只写变量名和用途，示例值一律用占位符，并注明从哪里获取。
ACCEPTANCE
怎么判断输出合格
- 启动命令和项目实际配置一致，照着做能跑起来。
- 上手步骤在文档最前面，不用先读一大段介绍。
- 敏感配置只有变量名和获取途径，没有示例密钥。
- 写明了常见启动失败的原因和排查方向。
SAFETY BOUNDARY
使用边界
- 文档里的安装命令和配置示例要实际跑一遍，模型给的参数和版本经常对不上。
- 示例配置里的连接串、密钥和内网地址必须替换成占位符再提交。