diataxis

Classify and restructure technical documentation using the Diataxis methodology.

Updated Jul 20, 2026
One-click install
npx skills add https://github.com/trancee/MeshLink-template --skill diataxis-trancee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diataxis
Source: https://github.com/trancee/MeshLink-template/tree/main/.agents/skills/diataxis
Command: npx skills add https://github.com/trancee/MeshLink-template --skill diataxis-trancee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill resolves documentation bloat and confusion by providing a structured, user-centric framework to classify and organize content, ensuring that tutorials, how-to guides, reference material, and explanations remain distinct and effective.

Core Features & Use Cases

  • Content Classification: Uses the Diataxis compass to determine if content serves learning, action, information, or understanding.
  • Audit & Restructure: Identifies common anti-patterns like mixed-type documents or leaked explanations in tutorials.
  • Use Case: Use this skill when you are struggling to organize a new project's README or when you need to audit an existing documentation site to improve user navigation and clarity.

Quick Start

Invoke the diataxis skill to audit the current documentation structure and suggest a plan to separate tutorials from reference material.

Frequently Asked Questions about diataxis

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

FAQPage Schema
How do I audit existing technical documentation to fix structural confusion?

To audit technical documentation, apply the Diataxis framework to classify content, identify anti-patterns like mixed-type documents, and separate tutorials from reference material to improve navigation and clarity.

What is the best way to organize a software project README and wiki?

Organizing a software project README and wiki requires a systematic information architecture that separates learning-oriented tutorials from task-oriented how-to guides, reference material, and explanations.

Why does my technical writing mix learning content with reference material?

Technical writing often mixes learning content with reference material due to a lack of structured content design, causing common anti-patterns like leaked explanations in tutorials that degrade developer experience.

Can I use the Diataxis framework to restructure a knowledge base?

Yes, you can use the Diataxis framework to restructure a knowledge base by systematically classifying existing content into four distinct types, resolving documentation bloat and improving user-centric navigation.

When should I separate tutorials from how-to guides in my documentation?

You should separate tutorials from how-to guides whenever a document serves both learning and action, as mixing these content types creates anti-patterns that confuse readers and disrupt the information architecture.