nw-quality-validation

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

322 stars

Best use case

nw-quality-validation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

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

Teams using nw-quality-validation should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/nw-quality-validation/SKILL.md --create-dirs "https://raw.githubusercontent.com/nWave-ai/nWave/main/nWave/skills/nw-quality-validation/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/nw-quality-validation/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How nw-quality-validation Compares

Feature / Agentnw-quality-validationStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

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

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

# 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 "what" | [ ] Provides context and reasoning
- [ ] Discusses alternatives | [ ] No task steps | [ ] Builds conceptual model

## Verdict Criteria

- **approved**: Passes all type-specific validation, no collapse violations, meets quality gates
- **needs-revision**: Minor issues fixable in place (clarity, missing examples, small gaps)
- **restructure-required**: Collapse detected requiring split, or fundamental type mismatch

Related Skills

nw-quality-framework

322
from nWave-ai/nWave

Quality gates - 11 commit readiness gates, build/test protocol, validation checkpoints, and quality metrics

nw-dor-validation

322
from nWave-ai/nWave

Definition of Ready checklist criteria, antipattern detection patterns, UAT quality rules, and domain language enforcement for product owner review

nw-ux-web-patterns

322
from nWave-ai/nWave

Web UI design patterns for product owners. Load when designing web application interfaces, writing web-specific acceptance criteria, or evaluating responsive designs.

nw-ux-tui-patterns

322
from nWave-ai/nWave

Terminal UI and CLI design patterns for product owners. Load when designing command-line tools, interactive terminal applications, or writing CLI-specific acceptance criteria.

nw-ux-principles

322
from nWave-ai/nWave

Core UX principles for product owners. Load when evaluating interface designs, writing acceptance criteria with UX requirements, or reviewing wireframes and mockups.

nw-ux-emotional-design

322
from nWave-ai/nWave

Emotional design and delight patterns for product owners. Load when designing onboarding flows, empty states, first-run experiences, or evaluating the emotional quality of an interface.

nw-ux-desktop-patterns

322
from nWave-ai/nWave

Desktop application UI patterns for product owners. Load when designing native or cross-platform desktop applications, writing desktop-specific acceptance criteria, or evaluating panel layouts and keyboard workflows.

nw-user-story-mapping

322
from nWave-ai/nWave

User story mapping for backlog management and outcome-based prioritization. Load during Phase 2.5 (User Story Mapping) to produce story-map.md and prioritization.md.

nw-tr-review-criteria

322
from nWave-ai/nWave

Review dimensions and scoring for root cause analysis quality assessment

nw-tlaplus-verification

322
from nWave-ai/nWave

TLA+ formal verification for design correctness and PBT pipeline integration

nw-test-refactoring-catalog

322
from nWave-ai/nWave

Detailed refactoring mechanics with step-by-step procedures, and test code smell catalog with detection patterns and before/after examples

nw-test-organization-conventions

322
from nWave-ai/nWave

Test directory structure patterns by architecture style, language conventions, naming rules, and fixture placement. Decision tree for selecting test organization strategy.