What is the Diátaxis model used by this skill?

Diátaxis is a systematic framework for technical documentation that separates content into four distinct types based on user needs: tutorials for learning, how-to guides for tasks, reference for facts, and explanation for understanding.

When should I use the diataxis-doc-planner?

Use it when you need to overhaul your docs, plan a new documentation site, or when you find that your current pages are mixing instructions with conceptual theory, making them hard to follow.

How does it handle project README files?

It treats the README as a landing page rather than a documentation quadrant, ensuring it provides essential entry points and summaries without becoming a dumping ground for all technical details.

Does this skill write the documentation content itself?

This skill focuses on the architecture and planning phase. It provides the classification and structure, which serves as a blueprint for Claude or a writer to then generate high-quality, targeted content.

Diátaxis Documentation Planner

Name: Diátaxis Documentation Planner
Author: jayteealao

byjayteealao

0•

学习与文档

Organizes and structures technical documentation using the Diátaxis framework to create clear, purposeful content maps.

This skill helps developers and technical writers move from ambiguous documentation requests to structured, actionable plans by applying the Diátaxis framework. It classifies content into four distinct quadrants—Tutorials, How-to guides, Reference, and Explanation—ensuring that each piece of documentation serves a specific user need without purpose-drift. By generating writing orders, classification tables, and boundary checks, it helps avoid bloated READMEs and ensures a professional documentation architecture for any software project.

主要功能

01Prevents purpose-drift by identifying and splitting mixed-intent pages

02Identifies boundary violations between different types of technical content

03Provides specific README routing rules to keep landing pages focused

040 GitHub stars

05Generates comprehensive documentation maps and prioritized writing plans

06Classifies content into Diátaxis quadrants (Tutorial, How-to, Reference, Explanation)

使用场景

01Planning the documentation architecture for a new open-source project or library

02Structuring a complex README that needs to link to detailed external documentation

03Auditing and reorganizing a legacy documentation set that has become hard to navigate

主要功能

01Prevents purpose-drift by identifying and splitting mixed-intent pages

02Identifies boundary violations between different types of technical content

03Provides specific README routing rules to keep landing pages focused

040 GitHub stars

05Generates comprehensive documentation maps and prioritized writing plans

06Classifies content into Diátaxis quadrants (Tutorial, How-to, Reference, Explanation)

使用场景

01Planning the documentation architecture for a new open-source project or library

02Structuring a complex README that needs to link to detailed external documentation

03Auditing and reorganizing a legacy documentation set that has become hard to navigate