Documentation Quality
CommunityAudit docs for quality and usefulness.
Authornsalvacao
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Documentation quality assessments ensure docs are not just present but actually helpful, accurate, and maintainable, reducing confusion and trapped knowledge.
Core Features & Use Cases
- Classify documentation assets (tutorials, how-to guides, reference, explanation) and map to appropriate workflows.
- Check README utility, installation clarity, quick-start effectiveness, and overall navigability.
- Verify doc-to-code alignment, configuration and API references, and correctness of examples.
- Assess documentation hierarchy and leverage for long-term maintenance to reduce debt.
Quick Start
Provide a repository and request a documentation quality audit to generate a structured report.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: Documentation Quality Download link: https://github.com/nsalvacao/nsalvacao-claude-code-plugins/archive/main.zip#documentation-quality Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.