skills.rest
Giskard-AI
Giskard-AIOFFICIAL
Explore all skills by this author →
WebsiteGitHub

diataxis-documentation

Classifies technical documentation into Diataxis-based types and improves clarity.

3|Updated Dec 17, 2025
Search Tags:#documentation#reference#framework#tutorials#diataxis#content-strategy
One-click install
npx skills add https://github.com/Giskard-AI/giskard-docs --skill diataxis-documentation-giskard-ai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: diataxis-documentation
Source: https://github.com/Giskard-AI/giskard-docs/tree/main/.cursor/skills/diataxis-documentation
Command: npx skills add https://github.com/Giskard-AI/giskard-docs --skill diataxis-documentation-giskard-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

The Diataxis Documentation Skill helps teams identify the appropriate documentation type (Tutorials, How-to Guides, Reference, Explanations) and apply best practices to improve clarity, structure, and user-centered outcomes across a project.

Core Features & Use Cases

  • Determine the correct documentation type using the Diataxis compass (acquisition vs. application, action vs. cognition) to prevent blur between types.
  • Load and reference specialized materials for each type from the provided references (Tutorials, How-to Guides, Reference, Explanations, and Framework Overview references) to guide authoring decisions.
  • Support iterative improvement by evaluating content in small, single-purpose pieces and guiding cross-linking and content separation to maintain distinctness.
  • Apply the framework across diverse content: tutorials for beginners, how-to guides for tasks, reference docs for facts, and explanations for context.

Quick Start

Start with a single content piece, identify its primary user need, and perform a small, focused Diataxis-based improvement.

Frequently Asked Questions about diataxis-documentation

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

FAQPage Schema
What is the Diataxis framework for technical documentation?▼

The Diataxis framework structures technical documentation into four distinct types: tutorials, how-to guides, reference docs, and explanations. It organizes content based on user needs across acquisition versus application and action versus cognition to improve clarity and audience fit.

How do I organize technical documentation into the correct content types?▼

You organize technical documentation by evaluating content against the Diataxis compass to determine if it serves learning, practical goals, information, or understanding. This prevents blur between types by maintaining distinct categories and guiding cross-linking between related documents.

How do I separate tutorials from how-to guides in my documentation?▼

Tutorials focus on learning for beginners, while how-to guides focus on accomplishing specific tasks. Applying the Diataxis framework helps evaluate content in single-purpose pieces, ensuring each document maintains its distinct purpose and prevents category overlap.

Can I use the Diataxis framework to improve existing technical docs?▼

Yes, you can improve existing technical docs by starting with a single content piece, identifying its primary user need, and performing a focused Diataxis-based evaluation. The framework supports iterative improvements by enforcing content separation and cross-type linking.

When should I not use Diataxis for documentation structure?▼

Diataxis may not suit projects lacking distinct user needs across learning and task execution. If your documentation does not require separation into tutorials, how-to guides, reference, and explanations, enforcing strict categorization could introduce unnecessary structural overhead.

Related Skills

Explore More Content & Communication Skills→
rethinkhealthrethinkhealth
6

writing-documentation-with-diataxis

Organize technical documentation using the Diataxis framework.

Official
Intermediate
abatiloabatilo
10

diataxis-documentation

Generate Diataxis-compliant documentation covering tutorials, how-to guides, explanations, and references.

Community
Basic
sammcjsammcj
155

writing-documentation-with-diataxis

Apply the Diataxis framework to identify and structure technical documentation types.

Community
Basic
ghalacticghalactic
2

diataxis

Classify technical documentation into tutorials, guides, references, and explainers.

Official
Intermediate