README 怎么写：项目 README.md 生成提示词（快速开始、配置表、常见问题一次写全）
开源项目准备发布、或内部项目要交接时用：根据项目文件生成一份新人照着就能跑起来的 README.md，命令只取自项目里真实存在的脚本，缺的信息列成待补充清单。
通用大模型 对话模型通用
【角色】你是一名开发者体验（DX）工程师，评判 README 的唯一标准是：一个从没见过这个项目的新人，能否在 10 分钟内照着把它跑起来。 【项目资料】 - 项目一句话用途：[项目用途] - 目标读者：[开源用户/公司内部同事/甲方运维] - 技术栈与运行环境：[语言框架与版本] - 依赖清单与脚本文件（package.json、pyproject.toml、Makefile、docker-compose.yml 等，原样粘贴）： [粘贴配置文件] - 环境变量示例文件（.env.example，删掉真实值）： [粘贴环境变量示例] - 目录结构（tree -L 2 的输出）： [目录结构] - 已有的说明或注意事项（没有就写无）：[已有说明] 【任务】按下面的章节写 README.md，读者用不到的章节可以删掉并说明理由： 1. 标题 + 一句话说明「它解决什么问题、给谁用」，必要时加徽章占位。 2. 功能特性：3–6 条，写用户能感知的能力，不写内部实现。 3. 快速开始：前置依赖及最低版本 → 克隆 → 安装 → 配置 → 启动 → 如何确认启动成功（访问哪个地址、看到什么输出）。 4. 配置说明：环境变量表（变量名 | 是否必填 | 默认值 | 说明 | 示例）。 5. 常用命令：开发、测试、构建、代码检查、数据库迁移，各一行说明。 6. 目录结构：只解释关键目录，每个一句话。 7. 部署（如适用）与常见问题 FAQ（端口占用、依赖版本冲突、权限问题等，结合技术栈写 3–5 条）。 8. 贡献方式与许可证（开源项目才写；许可证以仓库里的 LICENSE 为准，不确定就留占位）。 【约束】 - 所有命令必须能在我给的配置文件里找到依据；找不到的写成「TODO：确认 xxx 命令」，绝不编造脚本名或端口号。 - 命令放在代码块里，一行一条，可以直接复制；涉及不同操作系统的命令分别给出。 - 不出现真实密钥、内网地址和个人联系方式。 - 语言简洁，避免「强大的」「极致的」这类营销词。 【输出格式】 先输出完整的 README.md（放在一个 markdown 代码块里），再单独列出「需要我补充或确认的信息」清单。
高亮处换成你自己的内容：[项目用途]、[开源用户/公司内部同事/甲方运维]、[语言框架与版本]、[粘贴配置文件]、[粘贴环境变量示例]、[目录结构]、[已有说明]
ChatGPT Plus 充值
已被复制 0 次
使用说明
怎么填变量：最有用的输入是配置文件原文——package.json 里的 scripts、Makefile 的目标、docker-compose.yml 的端口映射，AI 才能写出真实可用的命令，而不是通用的 npm start。[目标读者] 会改变写法：给运维看的要写清端口、数据目录和日志位置；给开源用户看的要把截图和使用示例放前面。
常见坑：
- AI 最常见的错误是编造命令和默认端口，所以模板里要求它找不到依据就写 TODO，拿到结果后逐条核对。
- 环境变量示例一定先把真实值换掉再粘贴。
- 写完后请一位没接触过项目的同事照着做一遍，卡住的地方就是 README 要补的地方。
追问技巧：追问「站在第一次运行就失败的新人角度，列出最可能卡住的 5 个地方并补进 FAQ」；开源项目还可以要求「再写一个英文版」。
示例输出
示例，仅供参考（节选）
快速开始
需要 Node.js 20 及以上、pnpm 9。
bash
git clone <仓库地址>
cd order-service
pnpm install
cp .env.example .env # 按下表填写
pnpm dev看到 Listening on http://localhost:3000 即启动成功。
| 变量名 | 必填 | 默认值 | 说明 |
|---|---|---|---|
| DATABASE_URL | 是 | 无 | PostgreSQL 连接串 |
| LOG_LEVEL | 否 | info | 日志级别 |
需要确认：TODO：确认生产环境的构建命令（package.json 中没有 build 脚本）。
同款作品
用这条提示词做出来的作品；原作者会因此获得积分
还没有同款，来做第一个。
0 条评论
还没有评论，来抢沙发～