用途:tutorial-writer 用于编写从零到可运行结果的初学者友好教程,属于 Diátaxis 框架中的学习导向(Tutorial)文档类型,强调教学而非单纯记录。
主要能力:按步骤拆解教学流程,每步给出明确成功标准和可验证结果;编写前先对照源码验证 API 签名,确保无虚构方法、无错误参数;提供完整可运行示例,并附带预期输出与时间估算;采用渐进式复杂度,首步尽量简单以建立信心。
使用方式:手动调用 /skill tutorial-writer 或提出如“为新开发者编写入门指南”的需求。工作流程包括目标定义、源码研究、步骤拆解、写作、测试、验证六个阶段。可加载参考文件获取模板与规范,例如读取 ~/.claude/skills/tutorial-writer/references/TUTORIAL-TEMPLATE.md(完整模板与示例)、PITFALLS-GUIDE.md(常见错误)、TESTING-VERIFICATION.md(测试与验证流程),以及 ~/.claude/skills/shared/references/DIATAXIS-FRAMEWORK.md(Diátaxis 框架说明)。
输出与适用场景:输出为 Markdown 文件,常见位置如 docs/tutorials/getting-started-with-[feature].md、项目根目录 TUTORIAL.md 或 docs/getting-started/[feature].md。适合新手引导文档、新功能发布后的入门教程,可与 api-doc-writer、migration-guide-writer 等技能配合。
限制:教程需实际测试,未通过不可发布;不包含完整 API 参考、问题解决模式、深层原理解释或生产部署内容,这些应链接到相应文档;不能虚构 API、签名或代码;时间估算需为初学者留出缓冲;装饰性 emoji 与营销语言不被允许。复杂教程创建约需 4-8 小时,包含测试时间。