documentation-qa-knowledge
Documentation QA Knowledge Base
Quick reference for documentation quality assessment and audit criteria.
Quality Dimensions
Core Quality Metrics
| Dimension | Description | Weight |
|---|---|---|
| Completeness | All APIs/features documented | 25% |
| Accuracy | Code matches documentation | 25% |
| Clarity | Understandable, no jargon | 20% |
| Consistency | Terms, style, format uniform | 15% |
| Navigation | Easy to find information | 10% |
| Freshness | Up-to-date with latest version | 5% |
Quality Scoring
More from dykyi-roman/awesome-claude-code
psr-overview-knowledge
PHP Standards Recommendations (PSR) overview knowledge base. Provides comprehensive reference for all accepted PSRs including PSR-1,3,4,6,7,11,12,13,14,15,16,17,18,20. Use for PSR selection decisions and compliance audits.
23detect-code-smells
Detects code smells in PHP codebases. Identifies God Class, Feature Envy, Data Clumps, Long Parameter List, Long Method, Primitive Obsession, Message Chains, Inappropriate Intimacy. Generates actionable reports with refactoring recommendations.
16clean-arch-knowledge
Clean Architecture knowledge base. Provides patterns, antipatterns, and PHP-specific guidelines for Clean Architecture and Hexagonal Architecture audits.
16bug-root-cause-finder
Root cause analysis methods for PHP bugs. Provides 5 Whys technique, fault tree analysis, git bisect guidance, and stack trace parsing.
15ddd-knowledge
DDD architecture knowledge base. Provides patterns, antipatterns, and PHP-specific guidelines for Domain-Driven Design audits.
15testing-knowledge
Testing knowledge base for PHP 8.4 projects. Provides testing pyramid, AAA pattern, naming conventions, isolation principles, DDD testing guidelines, and PHPUnit patterns.
13