Where does the skill store documentation files?

To maintain a clean project structure, this skill strictly enforces that all generated documentation is stored within the /docs directory.

Does this skill help with code examples?

Yes, one of the mandatory rules is the use of 'Real Examples'. The skill replaces generic 'foo/bar' placeholders with runnable code relevant to your specific project.

What is the Diataxis framework used by this skill?

Diataxis is a systematic approach to technical documentation that organizes content into four categories based on user needs: Tutorials (learning), How-To Guides (problem-solving), Reference (information), and Explanation (understanding).

Why does the skill exclude meeting notes and status reports?

The skill focuses on 'evergreen' documentation. Temporal information like status updates and meeting notes are excluded from the /docs folder to prevent documentation from becoming stale and cluttered.

Documentation Writing

Name: Documentation Writing
Author: rysweet

byrysweet

•

学习与文档

Generates high-quality, discoverable software documentation following the Diataxis framework and industry-standard best practices.

The Documentation Writing skill for Claude Code transforms project documentation into a professional, well-structured resource by enforcing the Diataxis framework and the 'Eight Rules' of technical writing. It automatically organizes content into four distinct categories—tutorials, how-to guides, reference material, and conceptual explanations—ensuring that information is easy to find and use. By mandating real, runnable code examples and strictly managing file locations and internal linking, this skill helps developers maintain an evergreen documentation site that remains useful and accurate as the project evolves.

主要功能

0116 GitHub stars

02Diataxis framework implementation for structured content types

03Requirement for real, runnable code examples instead of placeholders

04Mandatory 'Eight Rules' enforcement for clarity and discoverability

05Separation of evergreen technical docs from temporal project status updates

06Automated internal linking and documentation index management

使用场景

01Generating API reference documentation with validated code snippets

02Building a comprehensive README and developer onboarding guide

03Creating step-by-step tutorials and task-oriented how-to guides

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add rysweet/amplihack documentation-writing

For use in Claude.ai and ChatGPT

Download Skill