documentation

Name: documentation
Availability: InStock
Author: novvoo

Create and structure technical documentation using the Diátaxis framework.

1|Updated Mar 5, 2026

Search Tags:#documentation #technical writing #reference #tutorials #how-to guides #diataxis #explanations

Ready to run

npx skills add https://github.com/novvoo/skill-router --skill documentation-novvoo

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps users create, organize, and improve technical documentation by applying the Diátaxis framework, ensuring clarity and effectiveness for different user needs.

Core Features & Use Cases

Documentation Type Selection: Guides users to choose between Tutorials, How-to Guides, Reference, and Explanations based on their goals.
Structured Content Creation: Provides patterns and best practices for writing each documentation type.
Use Case: A software team needs to document a new API. They can use this Skill to determine the best way to present the API reference, provide tutorials for common use cases, and explain the underlying architecture.

Quick Start

Use the documentation skill to help structure a new tutorial for a beginner audience.

Frequently Asked Questions about documentation

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

FAQPage Schema

What is the Diátaxis framework for technical documentation?▼

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.

How do I structure technical documentation for a new API?▼

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.

When should I use a tutorial versus a how-to guide?▼

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.

What is the best way to write reference pages for technical writing?▼

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.

Can I use this approach to review and improve existing documentation structures?▼

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.