What is the Diataxis framework?

It is a systematic approach to documentation that categorizes content into four types: Tutorials, How-To Guides, References, and Explanations to meet different user needs.

What style guides does this skill support?

The skill follows industry-standard guidelines from Google, Microsoft, GitLab, and Red Hat to ensure professional and consistent technical writing.

Can this skill help improve existing README files?

Absolutely. It can audit existing documentation for anti-patterns like passive voice, long sentences, and missing quick-start sections.

Is the documentation generated optimized for beginners?

Yes, it uses progressive disclosure and a 'Quick Start' philosophy to ensure new users can achieve success in under five minutes.

Does it help with API documentation?

Yes, it provides templates for TSDoc and other language-specific formats, emphasizing clear parameter descriptions and expected outputs.

Standardized Documentation Expert

Name: Standardized Documentation Expert
Author: MadAppGang

byMadAppGang

•

211

•

Learning & Documentation

Generates and audits technical documentation using industry-standard style guides from Google, Microsoft, and GitLab.

This skill empowers Claude to produce professional-grade technical documentation by applying authoritative best practices from industry leaders. It utilizes the Diataxis framework to structure content effectively, ensuring that everything from README files to API references is accessible, concise, and user-centric. By enforcing rules like active voice, progressive disclosure, and the use of the second person, this skill reduces cognitive load for readers and ensures that documentation is both technically accurate and easy to navigate.

Key Features

01Style guide enforcement based on Google, Microsoft, and GitLab standards

02211 GitHub stars

03Diataxis framework implementation for tutorials, how-to guides, and references

04Active voice and present tense validation to improve readability

05Automated README and quick-start template generation

06TSDoc and language-specific API documentation formatting

Use Cases

01Drafting comprehensive API documentation with expected input/output examples

02Structuring step-by-step tutorials that follow progressive disclosure principles

03Creating standardized README files for new or existing software projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add madappgang/claude-code documentation-standards

For use in Claude.ai and ChatGPT

Download Skill