Tutorial patterns for documentation - learning-oriented guides that teach through guided doing
View on GitHubskills/tutorial-docs/SKILL.md
February 1, 2026
Select agents to install to:
npx add-skill https://github.com/existential-birds/beagle/blob/main/skills/tutorial-docs/SKILL.md -a claude-code --skill tutorial-docsInstallation paths:
.claude/skills/tutorial-docs/# Tutorial Documentation Skill This skill provides patterns for writing effective tutorials following the Diataxis framework. Tutorials are learning-oriented content where the reader learns by doing under the guidance of a teacher. ## Purpose & Audience **Target readers:** - Complete beginners with no prior experience - Users who want to learn, not accomplish a specific task - People who need a successful first experience with the product - Learners who benefit from guided, hands-on practice **Tutorials are NOT:** - How-To guides (which help accomplish specific tasks) - Explanations (which provide understanding) - Reference docs (which describe the system) ## Core Principles (Diataxis Framework) ### 1. Learn by Doing, Not by Reading Tutorials teach through action, not explanation. The reader should be doing something at every moment. | Avoid | Prefer | |-------|--------| | "REST APIs use HTTP methods to..." | "Run this command to make your first API call:" | | "Authentication is important because..." | "Add your API key to authenticate:" | | "The dashboard contains several sections..." | "Click **Create Project** in the dashboard." | ### 2. Deliver Visible Results at Every Step After each action, tell readers exactly what they should see. This confirms success and builds confidence. ```markdown Run the development server: ```bash npm run dev ``` You should see: ``` > Local: http://localhost:3000 > Ready in 500ms ``` Open http://localhost:3000 in your browser. You should see a welcome page with "Hello, World!" displayed. ``` ### 3. One Clear Path, Minimize Choices Tutorials should not offer alternatives. Pick one way and guide the reader through it completely. | Avoid | Prefer | |-------|--------| | "You can use npm, yarn, or pnpm..." | "Install the dependencies:" | | "There are several ways to configure..." | "Create a config file:" | | "Optionally, you might want to..." | [Omit optional steps entirely] | ### 4. The Teacher Takes Responsibility I