docs-creating-tutorial-structure
/docs-creating-tutorial-structure
Prowadzi tworzenie i aktualizację tutoriali według siedmiu typów, siedmiosekcyjnego szablonu i zasad diagramów, z wymaganiami jakościowymi dla dokumentacji w katalogu docs/tutorials/.
- Autor
- wahidyankf ↗
- Repozytorium
- open-sharia-enterprise ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 27.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 6
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 27.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Prowadzi tworzenie i aktualizację tutoriali według siedmiu typów, siedmiosekcyjnego szablonu i zasad diagramów, z wymaganiami jakościowymi dla dokumentacji w katalogu docs/tutorials/.
Oryginalny opis (EN)
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/.
Jak działa
- Overview
- Reference Modules
- Core Principles
- Related Skills
Podgląd SKILL.md
--- 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
Pliki w paczce (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
Wersje
W bazie nie ma innych skilli o nazwie docs-creating-tutorial-structure.
Migawka bazy z 13.11.2026 · wersja paczki 95dc8f9d7978 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100docs-fixing-tutorial-quality
Weryfikuje ustalenia audytu tutoriali i naprawia usterki obiektywne, takie jak brakujące sekcje, delimitery LaTeX, nazewnictwo i frontmatter, a oceny subiektywne oznacza do ręcznego przeglądu. - 100writing-tutorials
Tworzy tutoriale dokumentacji Medusa w dwóch fazach: najpierw buduje funkcję w przykładowym projekcie (plan, kod, testy), potem pisze dokumentację MDX. - 100documentation
Tworzy, strukturyzuje i przegląda dokumentację techniczną według frameworka Diátaxis: tutoriale, przewodniki how-to, referencje i strony wyjaśniające. - 95Diataxis-Documentation
Planuje i porządkuje dokumentację według metodyki Diataxis: samouczki, poradniki, referencje i wyjaśnienia dla stron dokumentacji. - 90docs-authoring-standards
Podaje standardy pisania dokumentacji w repozytorium docs-maker: listę kontrolną poprawności, szablon frontmatter i zasady AGENTS.md. - 100tutorial-outline-creator
Tworzy konspekty tutoriali w obszarze dokumentacji technicznej, porządkując strukturę kroków i sekcji poradnika.