“给我一个教程大纲”得到的是干巴巴的步骤列表。好的教程大纲选一个具体结果、点明学员水平,并在每一步加一个学员能自查的成功标志。
适合哪些场景
DevRel 作者、课程创作者、写新员工 onboarding 文档的创业者、把项目转成指南的技术博主。
什么时候不建议这样写 Prompt
别用来写参考文档——格式不同。也别在自己没跑过一遍时用。
Prompt 结构公式
每个教程大纲 Prompt 都要带这六个要素:
- 读者:一个具体的人,不是”任何对 X 感兴趣的人”。
- 目标:一个动作——读完 / 点击 / 注册 / 同意 / 分享。
- 语气:品牌或作者语气,用 2-3 个锚定形容词。
- 限制:字数、禁用短语、必含事实。
- 格式:段落、列表、小标题、表格。
- 示例:1-2 条目标语气示例——匹配 voice 的最强杠杆。
这套 Prompt 适合用在哪
- 博客教程大纲
- 课程模块大纲
- 文档 walkthrough
- 内部 onboarding 文档
- 工作坊 / 演讲大纲
12 个可直接复制的 Prompt 模板
1. 结果导向大纲
I want to write a tutorial that ends with the learner achieving: `{outcome}`. Learner level: `{level}`. Time budget: `{minutes}` minutes. Output an outline with: (1) one-sentence promise, (2) prerequisites, (3) 5-8 numbered steps each with a success check, (4) common-pitfalls section, (5) what to do next.
可替换变量: outcome 学完能做到的事, level 学员水平, minutes 时长
2. 入门友好版
Rewrite this outline for absolute beginners. (1) Replace each jargon term with a plain-English version + a one-line side note for advanced readers, (2) Add a "first try" with a known-good fixture, (3) Halve any step that has > 3 substeps.
3. 先决条件
For tutorial topic `{topic}`, write the prerequisites section. Cover: (1) Knowledge prereqs, (2) Tools / accounts needed, (3) Working setup checks (a one-liner the reader can run), (4) Time estimate. Don't list optional reading.
可替换变量: topic
4. 每步成功检查
For this outline, append a success check to each step: a one-line "you should see X" the reader can verify before moving on. Don't add a check that requires output unavailable in the step itself.
5. 常见坑
For this tutorial, list 5 common pitfalls. For each: (1) symptom (what the learner will see), (2) cause, (3) one-line fix. Order by likelihood — most-frequent pitfall first.
6. 跨平台变体
For commands or code in this tutorial that differ on macOS / Windows / Linux, produce a small variant table. Don't fork the whole tutorial — only the lines that differ.
7. 长教程分章
My tutorial would be 90+ minutes. Split into a 3-part series. Each part: outcome, time budget, prerequisites (linking back to part 1), final state at end of part. Don't cliff-hang — each part must produce a usable artifact.
8. 视频脚本大纲
Convert this written tutorial outline into a video script outline: (1) Cold-open hook (5s), (2) "What we'll build" (15s), (3) Steps with screen-action notes, (4) Outro CTA. Optimise for retention: each section ≤ 60s of screen time.
9. 工作坊改编
Adapt this tutorial outline for a 60-minute live workshop: (1) Pre-work attendees must do, (2) In-room steps, (3) Pair-programming moments, (4) Q&A pause points, (5) Wrap with shipped artifact.
10. 课程模块化
Turn this tutorial into a course module: (1) Learning objectives (3-5), (2) Lessons (each with title + length + outcome), (3) Quiz at end with 3 questions, (4) Capstone exercise. Phrase objectives with measurable verbs (build, configure, deploy).
11. 大纲漏洞审查
Audit this outline for gaps: (1) Steps that assume an unstated prerequisite, (2) Jumps in difficulty, (3) Missing error-recovery, (4) Steps that produce no observable result. Output a fix list.
12. 新版本框架适配
Update this tutorial for `{frameworkVersion}`. List: (1) Steps that need rewrite due to API change, (2) New idiomatic patterns the old tutorial misses, (3) Deprecated terms to remove. Don't propose a full rewrite if 4 patches do it.
可替换变量: frameworkVersion
容易踩的坑
- 自己没端到端跑就开始写大纲。
- 没有成功检查——学员卡住不吭声。
- 先决条件写在最后。
- 只给一个平台的命令。
- 系列尾巴吊胃口。
- 把参考文档和教程当一种形态。
- 没写”下一步”——读者要桥到真实项目。
优化技巧
- 开头点明结果,不是话题。
- 每步只引入一个新概念。
- 可验证的成功检查很值钱。
- 坑写在代码前,学员中途会留意。
-
30 分钟就拆成系列。
- 收尾给”下一步”。
- 自己在干净机器上跑一遍验证大纲。
FAQ
- 教程多长合适?: 目标 15-30 分钟,再长拆系列。
- 先代码还是先文字?: 结果 → 为什么 → 步骤带代码 → 验证。别写”X 的历史”开头。
- 每步都要截图吗?: 只在文字单独误导时加。截图比文字烂得快。
- 怎么让教程不过时?: 锁框架版本;半年回看一次。
- 教程还是 how-to?: 教程教新手,how-to 假设已有上下文。
- AI 写完整教程吗?: 大纲 + 草稿可以;发布前自己跑一遍。