Does it help with creating 'Getting Started' guides?

Absolutely. It ensures your 'Getting Started' content functions as a true tutorial—a lesson where the user acquires a skill by doing—rather than a feature tour disguised as a guide.

How does this skill improve my README?

It analyzes your existing content to identify 'type mixing,' such as embedding long explanations inside a tutorial. It then helps you separate these into focused sections that are easier for users to navigate and digest.

What is the Diátaxis framework?

Diátaxis is a systematic approach to technical documentation that categorizes content into four types—Tutorials, How-to guides, Reference, and Explanation—based on whether the user is learning or working, and whether they need to act or understand.

Can I use this for API documentation?

Yes, the skill includes specific principles for 'Reference' documentation, ensuring your API docs remain austere, authoritative, and strictly descriptive rather than instructional.

Diátaxis Documentation Framework

Name: Diátaxis Documentation Framework
Author: joshuadavidthomas

byjoshuadavidthomas

•

Aprendizaje y Documentación

Applies the Diátaxis systematic framework to structure, classify, and write high-quality technical documentation.

This skill empowers Claude to act as a professional technical writer by implementing the Diátaxis framework, a systematic approach that divides documentation into four distinct types: learning-oriented tutorials, goal-oriented how-to guides, information-oriented references, and understanding-oriented explanations. It is an essential tool for developers and writers looking to improve documentation architecture, eliminate content mixing, and ensure that every piece of technical content serves a clear user intent and cognitive mode.

Características Principales

01Prevents type-mixing to ensure clarity and focus in technical writing

02Provides specific architectural patterns for tutorials, guides, reference, and explanation

034 GitHub stars

04Uses a 'Compass' decision tool to resolve ambiguity in documentation planning

05Classifies content into four distinct types based on user needs and cognitive modes

06Restructures existing README files and documentation sets for better navigation

Casos de Uso

01Refactoring a cluttered project README into distinct tutorials and practical how-to guides

02Drafting authoritative API reference documentation that remains objective and austere

03Creating 'Getting Started' lessons that prioritize user success over feature tours

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add joshuadavidthomas/agent-skills diataxis

For use in Claude.ai and ChatGPT

Download Skill