Cursor 新手指南:README 转提示词让 AI 先判断再输出
将项目的 README.md 转化为一份新手指南,表面看只是文字重组,实则有一个极易被忽视的陷阱:必须让 AI 真正理解文档的原始语义。如果你直接丢一句“请改成新手指南”,它大概率原样保留“npm install”,却只字不提需预装 Node.js,更不会提醒 Windows 用户使用 Git Bash 而非 CMD。最终产出的内容术语扎堆、前置依赖缺失,新手扫几眼就放弃。
因此,改写的起点不是动笔,而是让 AI 先做一次“结构诊断”。
让 AI 先梳理 README 结构再改写
打开 README.md 后,在编辑器右侧点击 Cursor 侧边栏的「Ask」按钮,输入一段明确的诊断指令:请逐段分析这篇 README:1. 哪些是安装步骤?2. 哪些是运行前提(如 Node 版本、环境变量)?3. 哪些概念对零基础用户完全陌生?4. 哪些命令缺少上下文(比如未指明在哪目录执行)?分析完再开始重写。
这一步不可跳过。如果你直接让 AI “改编成新手指南”,它会假定读者已具备全部背景知识,结果“npm install”照搬,却不解释前置条件。只有让 AI 先识别出知识盲区,后续的改写才能精准命中新手痛点。
用分阶段提示词控制输出节奏
方法一:两轮提示法
第一轮只做诊断,等 AI 输出分析结果后,第二轮再输入:“根据以上分析,把 README 重写成新手指南,要求:每步操作前加‘你需要’,每个命令后加‘这一步在做什么’,所有缩写首次出现时括号注明全称。”
方法二:单提示强制分段
直接输入:分三部分输出:① 诊断报告(列出 3 个新手最可能卡住的点);② 新手指南正文(用‘第一步’‘第二步’编号,每步含命令 + 作用 + 常见报错原因);③ 额外提醒(单独列出需要提前准备的工具和账号)。
必须明确要求“分三部分输出”,否则 AI 会把诊断和指南混在一起,新手读着读着突然看到一段分析文字,操作流程被割裂,体验直线下降。
防止 AI 擅自弱化关键约束
在提示词末尾追加一句硬性条件:保留所有版本号、路径、环境变量名,不替换成‘最新版’或‘你的项目名’;如果原文写了‘必须用 Python 3.9+’,改写后仍要强调‘必须’,不能弱化成‘建议’。
这一条遗漏的话,后果很直接——新手用 Python 3.12 跑项目撞墙,还得翻原文档核对版本要求。改写不但没降低认知负荷,反而多挖了一个坑。约束就是约束,不能因为“看起来友好”就随意削弱。
