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.

主要功能

01Validation of real, runnable code examples over placeholders

02Automatic enforcement of the 'Eight Rules' for documentation

03Diataxis framework integration for structured content types

04Inter-document linking and scanability verification

05Standardized directory structure management (docs/ folder)

0617 GitHub stars

使用场景

01Converting monolithic documentation into a structured Diataxis system

02Creating a comprehensive README and project index for a new repository

03Generating runnable API reference documentation for new software features

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