nw-quality-validation

Solid

Type-specific validation checklists, six quality characteristics, and quality gate thresholds for documentation assessment

AI & Automation 636 stars 68 forks Updated today MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
93
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
96
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Quality Validation ## Six Quality Characteristics - **Accuracy**: Factually correct, technically sound, current | Validation: expert review, automated testing - **Completeness**: All necessary info present for doc type | Validation: checklist, gap analysis - **Clarity**: Easy to understand, logical flow, appropriate level | Validation: Flesch 70-80 - **Consistency**: Uniform terminology, formatting, structure | Validation: style guide compliance - **Correctness**: Proper grammar, spelling, punctuation | Validation: automated check, zero errors - **Usability**: User achieves goal efficiently | Validation: task success, DIVIO type purpose served ## Quality Gate Thresholds | Metric | Threshold | |--------|-----------| | Readability (Flesch) | 70-80 | | Spelling errors | 0 | | Broken links | 0 | | Style compliance | 95%+ | | Type purity | 80%+ single type | ## Type-Specific Validation Checklists ### Tutorial Checklist - [ ] Completable without external references | [ ] Steps numbered and sequential - [ ] Each step has verifiable outcome | [ ] No assumed prior knowledge | [ ] Builds confidence ### How-to Checklist - [ ] Clear goal stated upfront | [ ] Assumes fundamentals known - [ ] Single task focus | [ ] Ends with completion indicator | [ ] No basics teaching ### Reference Checklist - [ ] All parameters documented | [ ] Return values specified - [ ] Error conditions listed | [ ] Examples per entry | [ ] No narrative ### Explanation Checklist - [ ] Addresses "why" not...

Details

Author
nWave-ai
Repository
nWave-ai/nWave
Created
9 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category