
Tutorial Docs
This is your guide for writing tutorials that actually teach. It's built on the Diataxis framework and focuses on learning by doing, not reading about doing. Every step should produce visible output with a "you should see" confirmation. No branching paths, no optional steps, just one clear route from zero to working thing. The template is opinionated about structure: show the end result first, keep prerequisites minimal, lead with actions instead of explanations, and take responsibility when readers get stuck. If you're writing getting started guides or any hands-on learning content, this gives you the patterns to make people successful on their first try.
- skills.sh installs
- 271
- GitHub stars
- 87
- last updated
- Aug 21, 2026
Install
$ npx -y skills add existential-birds/beagle --skill tutorial-docs --agent claude-codeInstalls into .claude/skills of the current project.
Files
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.
Dependency: Use this skill with docs-style for core writing principles. To confirm a tutorial is the right type — rather than a how-to, reference, or explanation — see docs-style/references/diataxis-compass.md.
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.
Sponsors
Details
- Repository
- github.com/existential-birds/beagle
- Categories
- Documentation, Code Review & Quality
- First seen
- Jun 3, 2026
More from existential-birds/beagle
All 40- Bubbletea Code Review265
- Zustand State258
- Adr Writing250
- Dagre React Flow247
- Swift Code Review247
- Pytest Code Review232
- Sqlalchemy Code Review225
- Pydantic Ai Common Pitfalls221
- Pydantic Ai Agent Creation219
- Agent Architecture Analysis217
- Ai Elements209
- Go Code Review204
- Shadcn Code Review204
- Swift Testing Code Review194
- Sqlite Vec171
- Pydantic Ai Tool System161
- Deepagents Architecture160
- Langgraph Implementation160
- Pydantic Ai Testing146
- Pydantic Ai Dependency Injection141
- Deepagents Implementation140
- Deepagents Code Review132
- Github Projects120
- Pydantic Ai Model Integration120