AgentSkillsCN

write-tutorial

遵循Diataxis框架,打造以学习为导向的文档。请主动启用以下场景:(1) 教学新概念,(2) 入门指南,(3) 新手入门文档,(4) 逐步学习路径。触发指令:“编写教程”“创建教程”“入门指南”“新手入门”“教我”“学习指南”“新手指南”

SKILL.md
--- frontmatter
name: write-tutorial
description: >
  Create learning-oriented documentation following Diataxis framework.
  PROACTIVELY activate for: (1) teaching new concepts, (2) onboarding guides,
  (3) getting started documentation, (4) step-by-step learning paths.
  Triggers: "write tutorial", "create tutorial", "onboarding guide", "getting started",
  "teach me", "learning guide", "beginner guide"
argument-hint: [topic]

Write Tutorial

Generate learning-oriented documentation optimized for the Anxious Novice persona.

When to Use

Use this skill when you need documentation that:

  • Teaches a new concept or skill from scratch
  • Guides a beginner through their first experience
  • Builds understanding progressively
  • Includes verification points so readers know they're on track

Workflow

Invoke the create-documentation skill for: "$ARGUMENTS"

Parameters to Apply

ParameterValueRationale
doc_typetutorialLearning-oriented, teaches by doing
personaanxious_noviceWorried reader who needs reassurance
reading_levelgrade_12Accessible but not condescending
include_examplestrueConcrete examples aid learning
validation_depthcomprehensiveTutorials need thorough validation

Required Elements

  1. Start with an analogy - Connect new concept to something familiar
  2. Clear prerequisites - What must the reader know/have before starting?
  3. Step-by-step progression - One concept at a time, building on previous
  4. Verification points - "If you see X, you're on track" checkpoints
  5. Recovery paths - What to do if something goes wrong
  6. Working example - Complete, runnable code they can copy

Cognitive Load Management

  • Intrinsic: Manage carefully - sequence concepts from simple to complex
  • Extraneous: Minimize aggressively - no jargon, clear language
  • Germane: Maximize - analogies, examples, reflection prompts

Output Format

The generated tutorial should follow this structure:

markdown
# [Tutorial Title]

## What You'll Learn
- [Outcome 1]
- [Outcome 2]

## Prerequisites
- [Requirement 1]
- [Requirement 2]

## [Step 1: First Concept]
[Analogy to introduce concept]
[Explanation]
[Example]
[Verification: "You should see..."]

## [Step 2: Building On Step 1]
...

## Troubleshooting
[Common issues and recovery paths]

## Next Steps
[Where to go from here]

Quality Gates

  • Analogy present in introduction
  • Prerequisites clearly stated
  • Each step has verification point
  • Recovery paths for common errors
  • No assumed knowledge beyond prerequisites
  • Code examples are complete and runnable