大多数 README 翻车在 install。读者在第 3 行碰到一个缺失的 peer-dep 就走了，根本看不到精彩部分。修法很硬：能跑的 install 步骤放最上、第一屏给真能跑的 quickstart、“install 失败怎么办”段放在营销之前。下面 12 个 Prompt 强制这个顺序。后续维护配 代码审查 Prompt。
这套 Prompt 适合用在哪
- OSS 库与框架
- 公司内部工具
- 独立产品与副业项目
- 模板 / starter / boilerplate
- 发布到 npm / pip / cargo 的 CLI 工具
1. 最小 README 骨架
项目：{name}。1 句话：{x}。目标读者：{who}。
请按此顺序只生成这些节：
1. Tagline（1 句，≤80 字符）
2. Install（最多 3 条命令）
3. Quickstart（≤30 行代码，演示最常见用法）
4. What's next（3 条链接：深入文档、示例、贡献）
不要"About"、不要"Features"清单、暂不要 badge。2. 一屏 quickstart
下面是项目入口 + 关键公开 API。
请写 ≤30 行 quickstart，端到端演示最常见用法（import、init、调用、打印结果）。
读者粘贴就能看到输出，不用读别的。
代码块后加 3 行解释刚才发生了什么。
入口 + API：{粘贴}3. install 排错块
项目 install 步骤：{清单}。需要的语言 / 运行时：{列版本}。
加 "If install fails" 段，覆盖此技术栈最常见的 5 种失败：
- peer-dep 冲突
- 版本不匹配（Node / Python / 运行时）
- 缺系统依赖（build tools、libssl 等）
- 权限 / sudo 问题
- 网络 / 代理 / 企业防火墙
每种给：如何识别（错误信息片段）、如何修（1-2 条命令）。4. 示例长廊
为 {name} 生成 5 个简短示例，覆盖不同用法（不是同一种的 5 个变体）。
每个：(a) 1 段背景——谁在什么场景下用，(b) 完整可跑代码块，(c) 1 行说明预期输出。
由简到难排序。每个相关联 1 个更深文档的链接。5. API 速查表
下面是模块的公开导出。请生成 1 张速查表，列：
名 | 类型（函数 / 类 / 常量） | 1 行描述 | 深入文档链接
排序：按使用频率，不按字母。
废弃 API 用删除线标记，加"改用 X"。
模块导出：{粘贴}6. 与替代品对比
{name} 与 {A}、{B}、{C} 竞争。诚实、不吹。
请写对比节：
- 1 段引言："如果 X 用 {name}，如果 Y 用 {A}"
- 4 行表，维度：速度、易用、范围、生态成熟度
- 用 ✓ / ✗ / 部分 标各家赢点
- 至少有 1 行替代品赢
末尾给替代品官网链接。7. CONTRIBUTING
请生成 CONTRIBUTING 段 ≤200 字，覆盖：
- 本地搭（clone、装 dev 依赖、起 watcher）
- 跑测试（全套 + 单条）
- 代码风格（linter / formatter 命令，不写规则）
- PR 清单（加了测试、更新 CHANGELOG、conventional commit）
- 怎么找 "good first issue"
余下链接到详细的 CONTRIBUTING.md。8. 审视已有 README
按清单审下面 README：
- 第一屏能找到 install 路径吗？
- 有可粘贴就能跑的 quickstart 吗？
- 常见 install 失败有处理吗？
- API 面 30 秒内能扫完吗？
- 对比节是据实，还是夸张？
每条失败给具体行号 + 1 行改写。
README：{粘贴}9. badge 与 shields 策略
为 {name}（{语言、包管理器}），建议哪些 badge 该放 README 顶、哪些是噪声。
输出：badge | 给读者传递什么信号 | 放（yes / no / only-if-X） | 理由。
最终清单不超过 5 个。优先影响 install 决策的（CI、版本、协议），不是虚荣指标（下载、star）。10. 封装 LLM 的库的 README
项目：一个 {语言} 库封装 {LLM API}。
请生成 README，处理大多数封装库忽略的 LLM 特有问题：
- API key 设置（env var、.env、密钥管理器）+ 安全警告
- 成本预期（每次调用估算、何时启用缓存）
- 限流与重试行为
- 流式 vs 阻塞模式
- "什么场景下不要用这个"段
Quickstart ≤30 行。展示 1 个流式和 1 个阻塞示例。11. CLI 工具 README
项目：名为 {name} 的 CLI，做 {什么}。
请生成 CLI 形态的 README：
- Install（homebrew / npm / pip / curl 一行，按分发方式）
- 30 秒用法：3 个示例调用，每个附预期 stdout
- 参数表：flag | 类型 | 默认值 | 作用
- 配置文件（若有）：路径、格式、示例
- 退出码
- 1 个真实错误 + 修复的排错示例12. 旧版本 README 改写
下面是当前 README，18 个月没动了。项目期间 {变了什么}。
请改写到反映今天的现实，不要让文件膨胀：
- 删失效链接和废弃 API
- 替换过时 install 指令
- 砍不再适用的节
- 自然位置加入 2-3 个最重要的新特性
输出：改写后的 README + 删了什么 / 为什么删的简短 changelog。
当前 README：{粘贴}
近期变更：{粘贴}容易踩的坑
- install 前有大段营销，没耐心的读者直接跑了
- Quickstart 跑不起来（引用了已删 API 或漏了 import）
- 没有”install 失败怎么办”，那 20% 在 Windows / 企业网络里的读者悄无声息放弃
- API 速查按字母排而不是按使用频率——读者刚好滚过他要的那条
- 对比节假装竞品没有任何赢点，整个 README 显得像广告