SuperAPI AI 工具集

tutorial-docs

写作与研究

查看项目

更新于 10-15 17:12

技能介绍

用途

tutorial-docs 是一个用于撰写教程类文档的技能,遵循 Diataxis 框架。教程是“以学习为导向”的内容,读者在教师的引导下通过动手实践来学习。

目标读者包括:完全没有相关经验的初学者;想要学习而非完成某个具体任务的用户;需要获得一次成功产品初体验的人;以及受益于引导式动手练习的学习者。

教程不是:How-To 指南(用于完成特定任务)、解释性文档(用于提供理解)、参考文档(用于描述系统)。

主要能力

该技能提供以下写作模式与规范:

  • 核心原则:通过行动而非讲解来教学;每一步都给出可见结果;只保留一条清晰路径、尽量减少选择;由教师(作者)为读者的成功负责;允许重复以建立信心;使用第一人称复数“我们”来叙述。
  • 教程模板:包含标题、简介、将要构建的内容、前置条件、分步操作、你学到了什么、后续步骤等结构。
  • 写作原则:标题约定(以行动结果开头,聚焦读者将做出的东西而非将学到什么,要具体);步骤结构(先行动、明确输入或点击内容、每步后确认成功、保持步骤小);前置条件管理(面向初学者,尽量精简)。
  • “You should see”模式:在每次重要操作后告诉读者应看到什么,用于确认成功。
  • 错误处理:预判失败并引导读者回到正轨,不责怪读者。
  • 组件用法:Frame(展示成功截图)、Steps(步骤内的编号序列)、Note/Warning/Tip(提示、警告、技巧)、带高亮行的代码块。
  • 发布前检查清单与分阶段发布门禁。

使用方式

该技能依赖 docs-style 获取核心写作原则。要确认某篇内容是否应写成教程(而非 How-To、参考或解释),可查阅 docs-style/references/diataxis-compass.md。

撰写时使用技能提供的教程模板组织内容,遵循核心原则与写作原则,在每一步后使用“You should see”模式确认结果,并借助 Frame、Steps、Note、Warning、Tip 等组件增强可读性。发布前按检查清单逐项核对,并按顺序完成发布门禁:草稿产物、可观察结果、单一路径、独立运行。

适用场景

当读者心态是“我想学习”时,适合使用教程,例如“构建你的第一个聊天机器人”。与之相对:当读者想“完成 X”时用 How-To;想“理解”时用解释性文档;想“查阅 Y”时用参考文档。

教程与 How-To 的关键区别:教程目的是通过动手学习,面向完全初学者,结构是单一线性旅程,不提供选择,解释极少,成功标准是读者学会并建立信心,篇幅更长、更多手把手引导;How-To 目的是完成特定任务,面向有一定经验的用户,结构是达成目标的步骤,可能展示替代方案,成功标准是读者完成任务,篇幅更短、更直接。

限制

该技能本身是文档写作模式与规范,不涉及具体产品功能、收费、价格、平台或效果。使用前需配合 docs-style;如需确认文档类型,需参考 docs-style/references/diataxis-compass.md。示例教程见 references/example-weather-api.md。相关技能包括 docs-style、howto-docs、reference-docs、explanation-docs。