HowToLearn

一套技术教程写作规范，适用于 Claude Code、DeepSeek、ChatGPT、Kimi 等所有 AI 工具。

这是什么

一套技术教程的写作规范。给 AI 加上这套规则后，它输出的教程风格统一、质量稳定、零基础也能看懂。

核心写作规则

规则	说明
一句话开场	先用一句话说清楚"这是什么"，再展开细节
生活类比	每个抽象概念都要有生活类比（Flask=自行车，FastAPI=电动车）
ASCII 图	架构图、流程图用字符画，表格用 Markdown
好坏对比	展示"低效做法 vs 高效做法"，读者从错误中学更多
代码可运行	带 import、带注释、带输出，不用 foo/bar 假数据
决策指引	对比选项时必须有"怎么选"的决策树，不能只列选项不推荐
速查表	每份教程都有 10 秒能扫完的参考表格
完整实战	至少一个从 0 到 1 的端到端案例
关联真实项目	用用户的真实项目举例，不只是抽象示例
中文为主	中文讲解，技术术语保留英文（Docker、FastAPI 等）

标准教程结构

一、XXX 是什么              ← 一句话说明 + 生活类比 + 现实应用
二、安装与环境               ← 安装命令 + 验证方法
三、核心概念                 ← 用表格和 ASCII 图解释
四、基础操作/入门             ← 可运行的代码示例
五、进阶用法                 ← 更复杂的代码示例
六、完整实战案例              ← 从 0 到 1 的端到端示例
七、常见场景速查              ← 场景→方案对照表
八、工具/方案选型             ← 对比表格 + 决策指引
九、注意事项/常见问题         ← 踩坑和解决方案
十、学习资源（可选）          ← 链接和路线建议

使用方式一：Claude Code（自动生效）

适合：安装了 Claude Code 的开发者

安装

# 1. 克隆仓库
git clone https://github.com/Tim-Y-boy/HowToLearn.git

# 2. 复制到你的项目（项目级）
cp -r HowToLearn/.claude/skills/ your-project/.claude/skills/

# 或者复制到全局（所有项目生效）
cp -r HowToLearn/.claude/skills/ ~/.claude/skills/

# 3. 重启 Claude Code

使用

直接说你想学什么，Skill 自动生效：

"出一份 Redis 教程"
"帮我整理一份 Kubernetes 入门指南"
"来一份 Rust 和 Go 的对比教程"

不需要加任何特殊命令，AI 自动按规范输出。

---

使用方式二：DeepSeek / ChatGPT / Kimi 网页版（手动粘贴）

适合：用浏览器打开 AI 网页的用户，不需要装任何东西

第一步：复制规则

打开这个链接，复制全部内容：

👉 technical-tutorial-writing.md

或者直接复制下面这段精简版：

请按照以下规则帮我写技术教程：

【写作规则】
1. 开头用一句话说清楚"这是什么"，加一个生活类比
2. 每个抽象概念都要有生活类比（比如 Flask=自行车，Django=汽车）
3. 用 ASCII 字符画表示架构图和流程图
4. 展示"低效做法 vs 高效做法"的对比
5. 代码示例必须可运行：带 import、带注释、带输出，不用 foo/bar
6. 对比多个选项时必须有"怎么选"的决策树
7. 每份教程要有 10 秒能扫完的速查参考表
8. 至少一个从 0 到 1 的完整实战案例
9. 用中文讲解，技术术语保留英文
10. 有常见踩坑和注意事项章节

【标准结构】
一、XXX 是什么（一句话说明 + 生活类比 + 现实应用）
二、安装与环境（安装命令 + 验证方法）
三、核心概念（用表格和 ASCII 图解释）
四、基础操作/入门（可运行的代码示例）
五、进阶用法（更复杂的代码示例）
六、完整实战案例（从 0 到 1 的端到端示例）
七、常见场景速查（场景→方案对照表）
八、工具/方案选型（对比表格 + 决策指引）
九、注意事项/常见问题（踩坑和解决方案）

第二步：粘贴到对话框

在 DeepSeek / ChatGPT / Kimi 的对话框中：

1. 先粘贴上面的规则
2. 然后写你的需求
3. 发送

完整示例

请按照以下规则帮我写技术教程：
（粘贴上面的规则内容）

---

现在请帮我写一份 Redis 入门教程，我完全没接触过，请从零开始讲。

第三步：后续对话不需要重复粘贴

同一个对话中，AI 会记住规则，直接说下一个需求即可：

再帮我出一份 Docker Compose 教程

新开对话需要重新粘贴规则。

---

使用方式三：保存为快捷提示词（一劳永逸）

适合：经常用的用户，不想每次都粘贴

DeepSeek 网页版

1. 打开 DeepSeek → 点击左上角「助手」
2. 创建新助手
3. 名称填：技术教程助手
4. 系统提示词粘贴完整的 Skill 内容
5. 保存

之后每次选这个助手，直接说需求就行。

ChatGPT 网页版

1. 打开 ChatGPT → 点击左上角 Explore GPTs → Create
2. Name 填：技术教程助手
3. Instructions 粘贴完整的 Skill 内容
4. 保存

之后选这个 GPT 使用。

Kimi 网页版

1. 打开 Kimi → 左侧「常用语」→ 添加常用语
2. 标题填：写技术教程
3. 内容粘贴规则
4. 保存

之后点常用语一键发送。

---

适合什么人

人群	推荐方式
用 Claude Code 的开发者	方式一：自动生效
用 DeepSeek/ChatGPT 的普通用户	方式二：粘贴规则
经常需要写教程的人	方式三：保存为快捷提示词
团队协作	方式一 + 把 Skill 提交到项目 Git

质量清单

交付前自动检查：

• 一句话说明 + 生活类比开场
• 至少 2 个对比表格
• 至少 1 个 ASCII 图
• 至少 1 个可运行代码示例（带输出）
• 有完整的端到端实战案例
• 有速查参考表
• 有"怎么选"的决策指引（涉及对比时）
• 有常见问题 / 踩坑章节
• 格式风格全文一致
• 零基础读者能独立跟上

反模式（避免）

反模式	为什么不好	正确做法
大段文字没有视觉分隔	读者是扫读不是精读	每 10-15 行用表格/图/代码打断
抽象概念没有类比	新手无法建立认知锚点	总是和熟悉的事物对比
示例用 foo/bar	不真实不可感	用汽车、用户、产品等真实数据
只展示最终结果	读者不知道中间过程	逐步展示，附带每步的输出
列了选项但不推荐	读者看完更迷茫	必须有决策树
代码没有注释	读者不知道为什么这样做	注释 WHY 不注释 WHAT
跳过安装步骤	读者卡在第 0 步	总是包含安装 + 验证命令

文件结构

HowToLearn/
├── .claude/
│   └── skills/
│       └── technical-tutorial-writing.md    ← Skill 文件
└── README.md                                ← 你正在看的文件

License

MIT