documentation-quality
Documentation Quality Standards
Use this skill when documentation should be judged against explicit standards instead of subjective preference.
Activation Conditions
- Reviewing docs before merge
- Creating or updating a style guide
- Defining expectations for examples, structure, and terminology
- Auditing a docs set for consistency and readability
Core Standards
- Clear audience and scope
- Stable heading hierarchy
- Runnable or honest examples
- Consistent terminology
- Explicit edge cases, constraints, and failure modes
Quality Checklist
- Title and purpose are clear
- Heading levels do not jump unexpectedly
- Code examples have language tags and realistic inputs
- Commands match current tooling
- Links and file paths are accurate
References & Resources
Documentation
- Writing Standards - Clarity, example quality, terminology, and formatting guidance
Scripts
- Doc Style Audit - Check Markdown files for heading jumps, long lines, tabs, and trailing whitespace
Cross-Client Portability
This skill is written to stay usable across GitHub Copilot, Claude Code, Codex, and Gemini CLI.
- GitHub Copilot: keep the folder in a Copilot-visible skill or plugin path, or wrap the workflow as project instructions if the host does not support portable skill folders directly.
- Claude Code: keep the folder in a local skills directory or a compatible plugin or marketplace source.
- Codex: install or sync the folder into
$CODEX_HOME/skills/<skill-name>and restart Codex after major changes. - Gemini CLI: this repository generates a project command named
/skills:documentation-qualityfrom this skill. Rebuild commands withpython scripts/export-gemini-skill.py documentation-qualityand then run/commands reloadinside Gemini CLI.
MCP Availability And Fallback
No dedicated MCP server is required for the normal workflow in this skill.
- If the current host lacks an equivalent tool surface, use the bundled scripts, standard shell or editor tooling, and the manual workflow already described in this skill.
- Treat local verification as the fallback evidence path before closing the task.
Related Skills
| Skill | Relationship |
|---|---|
| documentation-authoring | Apply quality standards during doc creation |
| documentation-verification | Verify quality metrics before merging docs |
| documentation-patterns | Patterns that enforce quality consistency |
More from practicalswan/agent-skills
stitch-design
Google Stitch design toolkit — DESIGN.md generation, screen-to-React conversion, shadcn/ui integration, prompt enhancement, and Remotion walkthroughs. Use when working with Stitch MCP design projects.
15php-development
PHP 8.0+ development — XAMPP, RESTful APIs, PDO/MySQL/MariaDB, and authentication. Use when building PHP backends, creating API endpoints, configuring XAMPP, or integrating PHP with databases.
14notion-docs
Notion workspace management via MCP - create databases, pages, comments, and knowledge bases. Use when building Notion documentation, organizing project wikis, or managing Notion content.
14mongodb-mongoose
MongoDB with Mongoose — schemas, models, aggregation pipelines, migrations, and Atlas connections. Use when designing collections, writing queries, or integrating MongoDB into Node.js/Next.js apps.
13frontend-design
UI/UX design — color theory (60-30-10 rule), responsive layouts, WCAG accessibility, CSS/Tailwind patterns, wireframes, and visual review. Use when designing interfaces, choosing palettes, writing CSS, or fixing layout/accessibility issues.
12documentation-automation
Automate doc generation with JSDoc/TSDoc, linters, and pre-commit hooks. Use when setting up markdownlint, configuring doc linting pipelines, integrating JSDoc/TSDoc, or building automated documentation workflows.
11