这个提示词用来做什么

README 写得很全，但新同事照着做还是卡住，问题通常出在顺序而不是内容

提示词全文

重写下面这份 README，目标只有一个：一个没接触过这个项目的人，能在五分钟内跑起来并看到结果。信息不要删，只改顺序和表达。

## 输入
现有 README：{粘贴}
项目是什么：{……}
跑起来的最短路径：{命令、依赖、需要的凭据或密钥}
已经有人反馈过的卡点：{……}

## 重排顺序
1）第一屏只放三样：一句话说清它是什么、一行安装、一行跑起来。三行之内必须出现可以复制的命令。
2）最小可运行示例：只给唯一一条路径，并写明前置条件（运行时版本、操作系统、要不要 API key、要不要联网）；能省掉的前置就省掉。
3）预期结果：贴出跑通之后应该看到什么（真实输出片段），让人能自己判断「我成功了没有」。
4）出错了先看这里：把最常见的三到五个失败现象和对应原因列成问答，覆盖网络、权限、版本三类。
5）配置与进阶用法：所有可选的东西挪到这里，不要混进快速开始。
6）最后才是背景、设计取舍、贡献方式、许可。

## 表达要求
- 每一步都要能被验证：读者做完这一步，知道下一步该做什么、也知道刚才那步成没成。
- 删掉「简单」「强大」「优雅」这类形容词，换成它实际做了什么。
- 命令按用户实际要敲的顺序排，别把注释写在命令前面。
- 语言平实、短句，不要 AI 腔。

## 最后
告诉我：按你重排后的版本，一个新人在哪一步最可能卡住，以及你会怎么提前解决它。

怎么用

  1. 把上面的提示词全文复制到对话窗口或工作流里。
  2. 把花括号占位符（如 {任务描述}）替换成你自己的内容。
  3. 条目越具体，产出越稳定；不需要的条目可以直接删掉。

输出示例

README 的问题很少是缺内容，而是顺序按作者的思路排、没按读者的顺序排。把「五分钟能跑起来」当唯一目标之后，配置项、架构说明、设计取舍都会自动往后走。3）预期结果那一段最值钱：新人自己判断不了成功与否，就会回来问人，问一次的成本比写十行输出示例高得多。

基本信息

  • 分类：文档
  • 标签：README · 文档结构 · 上手体验 · 开源协作 · 表达
  • 收录日期：2026-10-16

同类提示词