Skip to content
Skills Library
Programming · Writing

docs-creating-tutorial-structure

/docs-creating-tutorial-structure

The docs-tutorial-maker agent's structural methodology - the seven tutorial types and coverage levels, the tutorial-specific diagram orientation override (LR default, not the general TD default), the seven-section tutorial template (frontmatter through troubleshooting), and the create/update workflows with tutorial-specific quality requirements. Use when creating or updating tutorial documentation under docs/tutorials/.

Licence
MIT
Last repository change
27.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
6
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

The docs-tutorial-maker agent's structural methodology - the seven tutorial types and coverage levels, the tutorial-specific diagram orientation override (LR default, not the general TD default), the seven-section tutorial template (frontmatter through troubleshooting), and the create/update workflows with tutorial-specific quality requirements. Use when creating or updating tutorial documentation under docs/tutorials/.

Original author description

The docs-tutorial-maker agent's structural methodology - the seven tutorial types and coverage levels, the tutorial-specific diagram orientation override (LR default, not the general TD default), the seven-section tutorial template (frontmatter through troubleshooting), and the create/update workflows with tutorial-specific quality requirements. Use when creating or updating tutorial documentation under docs/tutorials/.

How it works

  1. Overview
  2. Reference Modules
  3. Core Principles
  4. Related Skills
Original SKILL.md headings · 35 lines, 182 words
SKILL.md preview
---
name: docs-creating-tutorial-structure
description: The docs-tutorial-maker agent's structural methodology - the seven tutorial types and coverage levels, the tutorial-specific diagram orientation override (LR default, not the general TD default), the seven-section tutorial template (frontmatter through troubleshooting), and the create/update workflows with tutorial-specific quality requirements. Use when creating or updating tutorial documentation under docs/tutorials/.
---

# Creating Tutorial Structure

## Overview

This Skill packages `docs-tutorial-maker`'s structural methodology for learning-oriented
tutorials, distinct from the universal `docs-applying-content-quality` and
`docs-applying-diataxis-framework` skills it also uses.

## Reference Modules

- [Tutorial Types and Diagram Orientation](reference/tutorial-types-and-diagrams.md) — the
  seven types with coverage percentages, and the tutorial-specific diagram orientation override
- [Tutorial Structure Template](reference/tutorial-structure-template.md) — the seven-section
  template (frontmatter, introduction, prerequisites, steps, validation, next steps,
  troubleshooting)
- [Workflow and Quality Requirements](reference/workflow-and-quality.md) — the create/update
  workflows and the tutorial-specific quality bar beyond general content quality

## Core Principles

- **Coverage percentages indicate depth, never duration** — state any time estimate separately, labelled as an estimate.
- **Explain WHY before HOW** — tutorials teach, they don't just narrate steps.
- **By Example tutorials use a separate, fully-specified skill** — see
  `docs-creating-by-example-tutorials` for the 75-90-example annotation methodology; this Skill
  does not duplicate it.

## Related Skills

- `docs-applying-content-quality` — universal active voice, heading hierarchy, accessibility
- `docs-applying-diataxis-framework` — the four documentation categories
- `docs-creating-accessible-diagrams` — Mermaid diagram standards (note the orientation override
  in reference module 01)
- `docs-creating-by-example-tutorials` — full methodology for the By Example tutorial type
Files in this package (6)
  • README.md 1 KB
  • SKILL.md 2 KB
  • reference/README.md 1 KB
  • reference/tutorial-structure-template.md 3 KB
  • reference/tutorial-types-and-diagrams.md 2 KB
  • reference/workflow-and-quality.md 3 KB

Versions

The database has no other skills named docs-creating-tutorial-structure.

Database snapshot: 13.11.2026 · package version 95dc8f9d7978 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100docs-fixing-tutorial-quality
    Domain-specific methodology for docs-tutorial-fixer — re-validating docs-tutorial-checker findings on pedagogical structure, then applying fixes only for objective issues (missing sections, LaTeX delimiters, naming, frontmatter) while flagging subjective narrative/style findings…
  • 100writing-tutorials
    Creates Medusa documentation tutorials in two phases: first builds the tutorial feature in an example project (with planning, coding, and tests), then writes the MDX documentation. Use when creating a new how-to tutorial or integration guide for the Medusa docs. Handles both…
  • 100documentation
    Creates, structures, and reviews technical documentation following the Diátaxis framework (tutorials, how-to guides, reference, and explanation pages). Use when a user needs to write or reorganize docs, structure a tutorial vs. a how-to guide, build reference docs or API…
  • 95Diataxis-Documentation
    Diataxis-based documentation methodology for creating, organizing, and planning documentation. USE WHEN user says 'set up docs', 'create documentation', 'document this project', 'plan documentation', 'organize docs', 'restructure docs', 'getting started guide', 'write a…
  • 90docs-authoring-standards
    Repository-specific documentation authoring standards for docs-maker — the correctness/verification checklist, frontmatter template, and the AGENTS.md navigation-document philosophy. Complements the universal docs-applying-content-quality and docs-applying-diataxis-framework…
  • 100tutorial-outline-creator
    Create tutorial outline creator operations. Auto-activating skill for Technical Documentation. Triggers on: tutorial outline creator, tutorial outline creator Part of the Technical Documentation skill category. Use when working with tutorial outline creator functionality.…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.