Where does this skill save documentation files?

The skill strictly enforces a project structure where all documentation is organized within the 'docs/' directory, ensuring files are easy to find and manage.

How do I trigger this skill in Claude Code?

It activates automatically whenever you use phrases like 'write documentation', 'create a README', 'document this API', or 'write a tutorial'.

What is the Diataxis framework?

Diataxis is a systematic approach to technical documentation that separates content into four distinct types based on user needs: tutorials, how-to guides, reference material, and conceptual explanations.

Does it support document-driven development?

Yes, the skill includes a 'Retcon' exception for writing documentation before implementation, allowing you to plan interfaces with [PLANNED] markers that are updated later.

Professional Documentation Writing

Name: Professional Documentation Writing
Author: rysweet

byrysweet

•

学习与文档

Generates high-quality, discoverable software documentation following the Diataxis framework and the Eight Rules of technical writing.

关于

This skill empowers developers to create structured, user-centric documentation by enforcing the Diataxis framework—distinguishing between tutorials, how-to guides, reference material, and conceptual explanations. It automates industry best practices such as centralizing files in a dedicated docs directory, ensuring all documents are interlinked, and replacing abstract 'foo/bar' placeholders with real, runnable code examples to improve developer experience and maintainability.

主要功能

Validation of real, runnable code examples over placeholders
Automatic enforcement of the 'Eight Rules' for documentation
Diataxis framework integration for structured content types
Inter-document linking and scanability verification
Standardized directory structure management (docs/ folder)
17 GitHub stars

使用场景

Converting monolithic documentation into a structured Diataxis system
Creating a comprehensive README and project index for a new repository
Generating runnable API reference documentation for new software features

关于

主要功能

Validation of real, runnable code examples over placeholders
Automatic enforcement of the 'Eight Rules' for documentation
Diataxis framework integration for structured content types
Inter-document linking and scanability verification
Standardized directory structure management (docs/ folder)
17 GitHub stars

使用场景

Converting monolithic documentation into a structured Diataxis system
Creating a comprehensive README and project index for a new repository
Generating runnable API reference documentation for new software features