skills.rest
rethinkhealth
rethinkhealthOFFICIAL
Explore all skills by this author →
WebsiteGitHub

writing-documentation-with-diataxis

Organize technical documentation using the Diataxis framework.

6|Updated Jan 29, 2023
Search Tags:#documentation#reference#explanation#tutorials#diataxis#how-to-guides#content-structure
One-click install
npx skills add https://github.com/rethinkhealth/glion --skill writing-documentation-with-diataxis-rethinkhealth
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-documentation-with-diataxis
Source: https://github.com/rethinkhealth/glion/tree/main/.claude/skills/writing-documentation-with-diataxis
Command: npx skills add https://github.com/rethinkhealth/glion --skill writing-documentation-with-diataxis-rethinkhealth

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams create and improve technical documentation by applying the Diataxis framework to identify the appropriate document type (tutorials, how-to guides, reference docs, or explanations) and to structure content for clear, usable guidance.

Core Features & Use Cases

  • Diataxis Compass for content classification (action vs cognition, acquisition vs application).
  • Guidance on choosing and producing the four documentation types to match user needs.
  • Practical templates and checklists for evaluating and refining documentation quality.
  • Use cases include authoring new docs, reviewing existing content, or deciding documentation strategy for a feature.

Quick Start

Create a Diataxis-based documentation plan for a new feature, outlining tutorials, how-to guides, references, and explanations.

Frequently Asked Questions about writing-documentation-with-diataxis

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 tutorials, how-to guides, references, and explanations. It classifies content by user needs across action versus cognition and acquisition versus application, ensuring documentation matches specific reader goals.

How do I organize technical documentation to match different user needs?▼

Organize technical documentation by applying the Diataxis framework to classify content into tutorials, how-to guides, references, or explanations. This addresses diverse user needs by separating learning-oriented content from practical task execution and technical information lookup.

How do I choose the right document type when writing technical docs?▼

Choose the right document type by using the Diataxis Compass to evaluate whether the content focuses on action or cognition and acquisition or application. This classification determines if the content should be a tutorial, how-to guide, reference, or explanation.

Can I use the Diataxis framework to review existing documentation?▼

Yes, you can use the Diataxis framework to review existing documentation. It provides practical templates and checklists for evaluating content quality, ensuring each document fits the correct category and maintains consistent language and structure requirements.

What's the best way to plan documentation structure for a new feature?▼

The best way to plan documentation for a new feature is creating a Diataxis-based plan that outlines required tutorials, how-to guides, references, and explanations. This ensures comprehensive coverage across all user learning and application needs before writing begins.

Does the Diataxis documentation structure enforce specific content requirements?▼

Yes, the Diataxis documentation structure enforces frontmatter and content structure requirements. It ensures consistent language across all four documentation types and integrates with existing content workflows to maintain quality during authoring and review.

Related Skills

Explore More Content & Communication Skills→
yocxy2yocxy2

document-generate

Generate Diataxis-compliant tutorials, guides, and references from repository context.

Community
Intermediate
frankxaifrankxai
6

Documentation Patterns

Organize technical documentation using Diataxis framework types and actionable templates.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced
sammcjsammcj
155

writing-documentation-with-diataxis

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

Community
Basic