Tech Tutorial

技术教程写作技能。当用户要求写教程、入门指南、手把手教学类文章时使用。产出结构清晰、循序渐进、包含代码示例的技术教程。

datawhalechina 2814be9 1.1 KB Updated

File contents

技术教程写作技能

适用场景

  • 用户要求写 "XXX 入门教程"、"手把手教你 XXX"
  • 文章类型为 tutorial / how-to / getting-started

写作方法论

Phase 1: 受众分析

  • 确定目标读者的技术水平(初级/中级/高级)
  • 识别前置知识要求
  • 设定学习目标(读完后读者能做什么)

Phase 2: 大纲设计

  • 采用 "概念 → 实践 → 深入" 的递进结构
  • 每章设置核心问题(读者读完这章应该能回答什么)
  • 预分配字数目标

Phase 3: 内容写作

  • 每个概念先给出直觉解释,再给出精确定义
  • 代码示例必须可运行,附带注释
  • 使用类比和图表辅助理解
  • 每章末尾设置 "检查点"(读者自测)

Phase 4: 质量检查

  • 确保代码示例无语法错误
  • 检查术语一致性
  • 验证学习路径的连贯性

datawhalechina/vibe-blog/tree/main/backend/skills/public/tech-tutorial commit 2814be9738

Frequently asked questions

npx skillmds@latest add datawhalechina/tech-tutorial