Where does this skill save documentation files?

Following the Eight Rules, all documentation generated by this skill is automatically placed in a centralized docs/ directory to ensure a consistent and discoverable project structure.

Does this skill provide real code examples?

Yes. A core requirement of this skill is to provide real, runnable code examples rather than generic placeholders, ensuring the documentation is immediately actionable for developers.

What is the Diataxis framework used by this skill?

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

How does it handle status updates or meeting notes?

The skill explicitly excludes temporal information like status reports or meeting notes from the docs/ directory, directing that content to appropriate locations like GitHub Issues or PR descriptions.

Documentation Writer

Name: Documentation Writer
Author: rysweet

byrysweet

•

Learning & Documentation

Generates professional, discoverable software documentation using the Diataxis framework and the Eight Rules principle.

This skill automates the creation of high-quality documentation by enforcing strict structural standards and the Diataxis methodology. It ensures all files are located in a centralized docs/ directory, properly cross-linked, and populated with real, runnable code examples rather than placeholders. Whether you need an API reference, a tutorial, or a project README, the skill guides Claude to maintain clarity, scanability, and technical accuracy while excluding temporal information that belongs in logs or issue trackers.

Key Features

01Automatic enforcement of the Eight Rules for documentation quality

02Automated cross-linking and index maintenance for improved discoverability

03Centralized documentation management in a standardized docs/ directory

04Mandatory use of real, runnable code examples instead of placeholders

05Diataxis framework integration for tutorials, how-tos, reference, and explanation

0617 GitHub stars

Use Cases

01Creating structured API references and how-to guides for complex features

02Refactoring existing scattered documentation into the Diataxis framework

03Generating a comprehensive README and project index for a new repository

Key Features

01Automatic enforcement of the Eight Rules for documentation quality

02Automated cross-linking and index maintenance for improved discoverability

03Centralized documentation management in a standardized docs/ directory

04Mandatory use of real, runnable code examples instead of placeholders

05Diataxis framework integration for tutorials, how-tos, reference, and explanation

0617 GitHub stars

Use Cases

01Creating structured API references and how-to guides for complex features

02Refactoring existing scattered documentation into the Diataxis framework

03Generating a comprehensive README and project index for a new repository