| name | write-tutorial |
| description | 编写新的教程文章。适用于用户要求创作新教程时。目标风格:读起来像一个真正懂行的人在跟你讲话,不装、不绕弯,但逻辑清晰、重点突出。 |
编写新教程技能
技能定位
本技能用于创作新教程文章,不是优化已有文章。
典型使用场景:
- 用户说"写一篇关于 XXX 的教程"
- 用户说"帮我创作一个新教程"
- 用户说"我想写一个介绍 XXX 的文章"
编写流程
第 0 步:确定教程序号与位置
在开始写作之前,先了解用户想写什么主题。
然后分析现有教程结构,根据以下原则确定合适的序号和位置:
- 序号从小到大递进:新教程的序号 = 已有教程数量 + 1
- 由浅入深排列:根据主题难度,确定插入到序列中的哪个位置
- 序号格式:
N-(N 为数字)
例如:现有 3 篇教程(序号 1-3),新主题难度介于 1 和 2 之间,则新教程序号为 2,原 2、3 顺延。
如果当前是第 1 篇:跳过此步骤,直接进入下一步。
第 1 步:调用子代理读取一篇
确定序号后,调用 prev-article-reader 子代理,传入当前教程序号 N,自动定位并读取序号 N-1 的上一教程。
调用方式:通过 Agent 工具,指定 subagent_type: prev-article-reader,传入当前教程序号 N。
子代理定义路径:.claude/agents/prev-article-reader.md
子代理会返回:
- 上一教程的核心主题与结论
- 上一教程已引入的概念与比喻(本篇无需重复解释)
- 上一教程结尾的内容预告(本篇开头应与之呼应)
- 衔接建议
第 2 步:提供大纲
结合连贯性信息,分析当前教程的内容范围,列出完整的文章结构大纲,标明各板块和子板块。
将大纲提交给用户审查,不要开始写正文。
第 3 步:等待用户确认大纲
停下来,等待用户对大纲的反馈。根据反馈调整大纲,直到用户确认。
第 4 步:逐板块填写内容
大纲确认后,一次只写一个板块。每个板块完成后停下,提交给用户审查。
第 5 步:用户审查循环
等待用户确认当前板块。根据反馈修改,确认无误后才继续下一板块。
第 6 步:重复直到全文完成
重复步骤 4-5,直到所有板块写完。
第 7 步:深度审查
全文完成后,调用 review-depth 子代理对全文进行深度审查。
调用方式:通过 Agent 工具,指定 subagent_type: review-depth,传入目标文章的路径和审查任务描述。
子代理定义路径:.claude/agents/review-depth.md
子代理会返回:
- 第一原则评估(换掉工具后价值剩余)
- 三个维度的评分(知识可迁移性、底层原理深度、小白可读性)
- 问题清单(含标记类型、位置、描述、修改建议)
- 优先修改项
根据审查报告逐一修改,再提交用户做最终确认。
排版规范
遵循 CLAUDE.md 中的强制排版规范。
语言风格规范
所有语言风格规范(口头禅、通俗易懂要求、比喻使用、结论强调等)详见:
→ .claude/reference/style-guide.md
内容准确性规范
参考官方文档
官方文档位于:reference/claude_code帮助文档/ 目录
创作教程文章时,必须:
- 读取官方文档中对应主题的内容
- 确保教程中的技术描述与官方文档一致
- 如果官方文档表述过于技术化,需要用通俗语言重新解释,但核心含义不能变
使用方法
用户可以通过以下方式调用此技能:
/write-tutorial 命令
- 说"写一篇关于 XXX 的教程"
- 说"帮我创作一个新教程"
技能会自动:
- 分析现有教程结构,确定新教程序号
- 调用
prev-article-reader 子代理(如果是教程系列),获取上一教程的摘要
- 检查连贯性:根据摘要判断如何自然衔接
- 提供大纲给用户审查
- 逐板块撰写内容,每板块等待用户确认
- 调用
review-depth 子代理进行深度审查
- 根据审查报告修改后,提交用户最终确认