Create and structure technical documentation using the Diátaxis framework.
npx skills add https://github.com/novvoo/skill-router --skill documentation-novvoo
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/novvoo/skill-router/tree/main/agent/skills/documentation Command: npx skills add https://github.com/novvoo/skill-router --skill documentation-novvoo
This Skill helps users create, organize, and improve technical documentation by applying the Diátaxis framework, ensuring clarity and effectiveness for different user needs.
Use the documentation skill to help structure a new tutorial for a beginner audience.
High-intent search queries and answers about installing and using this skill.
The Diátaxis framework structures technical documentation into four distinct types: tutorials, how-to guides, reference pages, and explanations. It ensures clarity by matching documentation to specific user needs and learning goals.
To structure technical documentation for a new API, apply the Diátaxis framework to separate API reference material from practical tutorials and architectural explanations. This organizes content based on user goals and learning stages.
Use tutorials to teach beginners through guided learning, and employ how-to guides to solve specific problems for users already familiar with the basics. The Diátaxis framework distinguishes these by user intent and goal.
The best way to write reference pages is to focus strictly on describing the mechanics and parameters without explaining concepts. The Diátaxis framework structures reference material as dry, information-oriented documentation.
Yes, you can review and improve existing documentation structures by mapping current content to the Diátaxis framework. This process identifies misplaced information and refines pages for better clarity and user alignment.
vivshawGenerates structured technical design plans with acceptance criteria, summaries, and glossaries.
JongsixGenerate technical documentation from source code and API definitions.
clover-stormDetect code changes from git diffs and update corresponding documentation sections.
CompSci-SquadCreate technical documentation following the Diátaxis Framework.
