What is the Diátaxis framework?

Diátaxis is a systematic approach to technical documentation that categorizes content into four types: tutorials, how-to guides, technical references, and explanations. This skill specifically handles the tutorial quadrant.

How does this differ from a how-to guide?

Tutorials are learning-oriented lessons for beginners meant to build confidence through a guided path. How-to guides are task-oriented instructions for users who already have some competence.

What makes a 'good' tutorial according to this skill?

A successful tutorial provides visible results early, minimizes conceptual detours, removes distracting choices, and guarantees a concrete, successful outcome for the learner.

Can I use this for troubleshooting?

No, this skill is strictly for beginner onboarding and first-project guides. It intentionally avoids troubleshooting and advanced tasks to keep the learner's path clear and successful.

Diátaxis Tutorial Writer

Name: Diátaxis Tutorial Writer
Author: jayteealao

byjayteealao

0•

学习与文档

Generates learning-oriented, hands-on tutorials based on the Diátaxis framework to build user confidence and skill.

This skill transforms Claude into an expert documentation engineer specializing in the Diátaxis framework's tutorial quadrant. It focuses on creating 'learning by doing' experiences for beginners, prioritizing immediate visible results and psychological safety over exhaustive technical coverage. By eliminating choice-paralysis and conceptual detours, it helps developers create onboarding materials and 'getting started' guides that ensure a successful first project outcome for new users.

主要功能

01Diátaxis-compliant tutorial structure

020 GitHub stars

03Minimalist explanation style to prevent cognitive overload

04Outcome-focused lesson planning

05Checkpoint-based progress validation

06Anti-pattern detection and removal for beginner safety

使用场景

01Creating 'Getting Started' guides for new software libraries or SDKs

02Drafting beginner-friendly documentation for open-source projects

03Writing first-project walkthroughs for internal engineering onboarding

主要功能

01Diátaxis-compliant tutorial structure

020 GitHub stars

03Minimalist explanation style to prevent cognitive overload

04Outcome-focused lesson planning

05Checkpoint-based progress validation

06Anti-pattern detection and removal for beginner safety

使用场景

01Creating 'Getting Started' guides for new software libraries or SDKs

02Drafting beginner-friendly documentation for open-source projects

03Writing first-project walkthroughs for internal engineering onboarding