用途:帮助作者把读者从“不会做”带到“能做”,产出以可运行代码、具体步骤和真实失败情况说明为基础的技术教程。
适用场景:为库、CLI 工具或 API 编写入门指南;编写读者可在终端跟随的分步教程;通过动手练习讲解技术概念;编写与 API 参考文档互补的操作指南。不适用于生成 API 参考文档、清理已有文稿、无运行步骤的高层架构概览,以及无动手环节的概念性文章。
主要流程:先确定范围与受众,声明读者层级(新手、实践者、专家或一句话画像),明确目标、一句话论点、唯一前置条件和明确排除范围;再产出逐节大纲;随后先写代码示例,每段代码须在真实环境运行后再写入教程,只注释非显而易见之处;围绕代码撰写正文,每步说明运行什么、做什么、预期结果,统一使用第二人称;从最小可运行示例开始逐步增加复杂度;起草后运行 Skill(scribe:slop-detector) 做冗余检查并修复一级问题;最后按质量门清单核验。
质量要求:所有代码块经过测试并产生所述输出;前置条件列出相关精确版本;每步说明预期结果;故障排查覆盖至少两种常见失败模式;避免一级冗余词、三连形容词堆叠和分词尾挂;破折号每千词少于 2 个;项目符号比例低于 40%;行宽 80 字符;论点出现在开头段落并在结尾呼应;不设“总结”式复述章节;受众层级在起草前声明,偏离该层级的内容移入链接的深入文章而非删除。
必需待办项:tech-tutorial:scope-defined、tech-tutorial:outline-approved、tech-tutorial:code-tested、tech-tutorial:prose-drafted、tech-tutorial:slop-scanned、tech-tutorial:quality-verified、tech-tutorial:user-approved。
模块参考:modules/outline-structure.md 提供章节顺序与长度目标;modules/code-examples.md 提供代码片段格式与注释规则;modules/progressive-complexity.md 提供节奏与分层指导。
与其他技能集成:起草后、批准前使用 scribe:slop-detector;配套 API 参考章节使用 scribe:doc-generator;匹配已有教程语气使用 scribe:style-learner。
退出标准:起草前确认大纲;起草前声明受众层级;所有代码片段在真实环境测试;冗余评分低于 1.5;偏离层级内容移入链接的深入文章;通过质量门清单;获得用户批准。