writing-quality

Name: writing-quality
Availability: InStock
Author: jsamuelsen11

Apply structured writing standards to technical documentation for clarity and accuracy.

Updated Feb 7, 2026

Search Tags:#documentation #writing #editing #clarity #structure #quality-assurance #audience-awareness

Ready to run

npx skills add https://github.com/jsamuelsen11/claude-config --skill writing-quality

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: writing-quality
Source: https://github.com/jsamuelsen11/claude-config/tree/main/plugins/ccfg-markdown/skills/writing-quality
Command: npx skills add https://github.com/jsamuelsen11/claude-config --skill writing-quality

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill defines and enforces clear, accurate, and complete technical writing standards to improve documentation quality and readability.

Core Features & Use Cases

Clarity rules: short sentences, active voice, present tense, concrete terms.
Technical accuracy: runnable examples, correct versioning guidance, and valid code/snippet syntax.
Audience awareness: guidance tailored for users, contributors, and API references.
Structure & completeness: progressive disclosure, checklists, and navigable documentation.
Use cases: drafting user guides, API references, developer docs, and internal design documents.

Quick Start

Apply these standards to draft or review your next technical document.

Frequently Asked Questions about writing-quality

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I improve technical documentation clarity and readability?▼

Improve documentation clarity by applying structured writing standards that enforce short sentences, active voice, present tense, and concrete terms across user guides and developer docs.

What writing standards should I apply when drafting API references?▼

Draft API references using standards that enforce technical accuracy, including runnable examples, correct versioning guidance, valid code syntax, and progressive disclosure tailored for specific audiences.

How can I ensure my developer documentation is complete and accurate?▼

Ensure developer documentation is complete by applying a structured checklist that verifies technical accuracy, valid snippet syntax, correct versions, and progressive navigable structure.

Does this documentation quality approach work for internal design documents?▼

Yes, these structured writing standards apply to internal design documents, user guides, and developer documentation, ensuring clarity, accuracy, and audience awareness across all technical content.

What is the best way to review technical documentation for audience awareness?▼

Review technical documentation for audience awareness by applying tailored guidance that distinguishes between end users, contributors, and API references, ensuring content suits each reader's context.

When should I use progressive disclosure in technical writing?▼

Use progressive disclosure in technical writing when structuring complex developer documentation or user guides to present information navigably, ensuring clarity without overwhelming the audience upfront.