write-tutorial

Generate Diataxis-framework tutorials with YAML frontmatter and runnable examples.

2|1|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/Agentient/vibekit --skill write-tutorial
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-tutorial
Source: https://github.com/Agentient/vibekit/tree/main/plugins/documentation-tools/skills/write-tutorial
Command: npx skills add https://github.com/Agentient/vibekit --skill write-tutorial

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reduce onboarding friction by generating learning-oriented documentation.

Core Features & Use Cases

  • Generates a tutorial structure aligned to the Diataxis framework, with prerequisites, step-by-step progression, verification points, and recovery paths.
  • Supports creating onboarding guides, getting-started materials, and structured learning paths for anxious novice readers.
  • Produces runnable examples and clear guidance to validate understanding.

Quick Start

Create a complete beginner-friendly tutorial following the Diataxis framework for a chosen topic.

Frequently Asked Questions about write-tutorial

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the Diataxis framework for writing tutorials?

Structured learning paths guide anxious novice readers through onboarding by providing step-by-step progression, runnable examples, and clear verification points. This reduces onboarding friction by ensuring users validate their understanding at each stage.

How do I create a getting-started tutorial with runnable examples?

To create a getting-started tutorial, define your topic and let the Skill generate a structured workflow including YAML frontmatter, prerequisites, step-by-step progression, and runnable examples. This enforces a learner-first structure aligned with the Diataxis framework.

Does this tutorial generator enforce specific frontmatter requirements?

Yes, the tutorial generator enforces YAML frontmatter that requires both a name and a description field. This ensures every generated learning-oriented document has standardized metadata for consistent onboarding documentation.

What's the best way to reduce onboarding friction for anxious novice readers?

The best way to reduce onboarding friction is providing structured learning paths with clear recovery paths and verification points. Generating learner-first tutorials helps anxious novices validate their understanding without getting stuck during onboarding.

Can I use this for structured learning paths beyond getting-started guides?

Yes, this Skill supports creating structured learning paths alongside onboarding guides and getting-started materials. It generates tutorials with step-by-step progression and recovery paths applicable to any learning-oriented documentation for novice users.