Can this skill help improve my existing README?

Yes, it follows an iterative process to assess existing paragraphs or pages and refactor them into the correct Diataxis category for better clarity.

How do I know which documentation type to use?

The skill uses a decision tree based on two questions: Is the user doing or learning? And do they need practical steps or theoretical knowledge?

Does it support API reference generation?

While it doesn't auto-generate code, it provides the structural framework and best practices for writing high-quality API and configuration reference material.

What is the Diataxis framework?

Diataxis is a systematic approach to technical documentation that organizes content into four types: tutorials for learning, how-to guides for tasks, reference for facts, and explanation for understanding.

Diataxis Documentation Framework

Name: Diataxis Documentation Framework
Author: abatilo

byabatilo

•

学习与文档

Applies the Diataxis framework to create structured, user-centric technical documentation across four distinct categories.

This skill empowers Claude to act as a professional technical writer by implementing the Diataxis documentation framework. It helps developers categorize their content into Tutorials, How-to Guides, References, and Explanations, ensuring that every piece of documentation serves a specific user need without overlap. Whether you are building a 'Getting Started' guide or a deep-dive architectural explanation, this skill provide the structural guidance and iterative improvement process needed to produce clear, professional, and highly usable documentation.

主要功能

01Ensures technical references remain factually dense and information-oriented

02Differentiates between learning-focused tutorials and task-focused how-to guides

03Classifies content into four distinct Diataxis documentation types based on user intent

04Implements an iterative improvement workflow for refining existing documentation

051 GitHub stars

06Provides specialized guidance for action-oriented vs. cognition-oriented content

使用场景

01Drafting a 'Getting Started' tutorial for a new software project to help beginners

02Refactoring a monolithic README into specialized tutorials and reference pages

03Auditing existing documentation to remove ambiguity and improve user navigation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add abatilo/vimrc diataxis-documentation

For use in Claude.ai and ChatGPT

Download Skill