Will it help make my docs more scannable?

Absolutely. It promotes the use of meaningful headings, bulleted lists for items, and tables for data comparisons instead of long paragraphs.

Can it help with code examples in my documentation?

Yes, it checks that code examples are runnable, uses current versions, and provides the necessary context or commands to be functional.

How does this skill improve technical writing?

It enforces specific standards like active voice, short sentences, and concrete language to make complex technical information easier to digest.

Does it support different types of documentation?

Yes, it understands the unique requirements for User Guides, Contributor Guides, API References, and Internal Design Docs.

Technical Writing Standards

Name: Technical Writing Standards
Author: jsamuelsen11

byjsamuelsen11

0•

コンテンツ管理

Enforces high-quality standards for technical documentation to ensure clarity, accuracy, and structural integrity.

This skill provides a rigorous framework for Claude to review and enhance technical writing. It focuses on converting passive voice to active, breaking down complex sentences for better readability, and ensuring code examples are technically accurate and runnable. By implementing principles like progressive disclosure and audience-aware formatting, it transforms dense technical prose into scannable, user-centric documentation such as API references, user guides, and architecture design records.

主な機能

01Validates technical accuracy and context for code examples

02Optimizes scannability using bulleted lists and comparison tables

03Applies progressive disclosure for better information architecture

04Enforces active voice and present tense for clear instructions

05Tailors detail levels specifically for users, contributors, or API consumers

060 GitHub stars

ユースケース

01Refactoring complex README files for better developer onboarding

02Drafting technical design documents that clearly communicate trade-offs

03Reviewing API documentation to ensure completeness and runnable examples

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jsamuelsen11/claude-config writing-quality

For use in Claude.ai and ChatGPT

主な機能

01Validates technical accuracy and context for code examples

02Optimizes scannability using bulleted lists and comparison tables

03Applies progressive disclosure for better information architecture

04Enforces active voice and present tense for clear instructions

05Tailors detail levels specifically for users, contributors, or API consumers

060 GitHub stars

ユースケース

01Refactoring complex README files for better developer onboarding

02Drafting technical design documents that clearly communicate trade-offs

03Reviewing API documentation to ensure completeness and runnable examples

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jsamuelsen11/claude-config writing-quality

For use in Claude.ai and ChatGPT