How do I activate the documentation writing skill?

The skill activates automatically when you use phrases like 'write documentation', 'create a README', 'document this feature', or 'write a tutorial' while using Claude Code.

What is the Diataxis framework used by this skill?

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

Does this skill help with code examples?

Yes. One of its mandatory 'Eight Rules' is to provide real, runnable code examples rather than using 'foo/bar' placeholders, ensuring the documentation is immediately useful to developers.

Where does this skill save documentation files?

By default, this skill enforces a strict organizational rule where all documentation is placed within the `docs/` directory of your project to ensure a clean and predictable structure.

Documentation Writing Assistant

Name: Documentation Writing Assistant
Author: rysweet

byrysweet

0•

학습 및 문서화

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

This skill transforms Claude into a professional technical writer that strictly adheres to the Diataxis framework and the Eight Rules of documentation. It ensures all content is organized within a dedicated `docs/` directory, maintains internal linking for discoverability, and replaces generic placeholders with runnable, project-specific code examples. By categorizing content into Tutorials, How-To guides, Reference material, and Explanations, it helps maintain a high-quality, professional knowledge base that stays free of temporal noise like status reports or meeting notes.

주요 기능

01Filters out temporal data like status updates to keep documentation evergreen

02Automatically organizes files into a standardized docs/ directory structure

03Enforces the Diataxis framework (Tutorials, How-To, Reference, Concepts)

04Ensures document discoverability via mandatory internal linking and index updates

050 GitHub stars

06Mandates real, runnable code examples instead of generic placeholders

사용 사례

01Generating API reference documentation with real-world implementation examples

02Creating step-by-step onboarding tutorials for new project contributors

03Transforming a single README into a structured documentation site with separate guides and references

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add rysweet/azlin documentation-writing

For use in Claude.ai and ChatGPT

Download Skill