outfitter-dev/agents-internal/docs-check

Documentation Check

Rigorous quality gate for documentation. Focused on correctness, completeness, and comprehensiveness — not just voice and style.

Usage

/docs-check [focus]

Examples

/docs-check                              # Full quality gate
/docs-check focus on code examples       # Verify examples run
/docs-check check API completeness       # Parameter coverage
/docs-check are all links valid?         # Link check
/docs-check just the Quick Start         # Section-specific

Arguments

Focus: $ARGUMENTS

Use arguments to narrow the scope:

Verification Checklist

Work through each dimension. For each item, document: PASS/FAIL + evidence.

Correctness (accuracy)

Completeness (nothing missing)

Comprehensiveness (depth)

Execution

1. Identify target — What documentation is being checked?
2. Run checks — Work through the checklist, executing verification steps
3. Collect evidence — Note specific line numbers, error messages, missing items
4. Classify issues — Blocking (must fix) vs. suggestions (nice to have)
5. Report — Structured output per format below

Output Format

# Documentation Check: {doc-name}
 
**Verdict**: PASS | NEEDS WORK | BLOCKED
**Blocking issues**: {count}
**Suggestions**: {count}
 
## Blocking Issues (must fix)
 
1.**{Check name}**: {Issue description}
   -Location: {file:line or section}
   -Evidence: {error message, mismatch, etc.}
   -Fix: {specific action to resolve}
 
## Suggestions (nice to have)
 
1.{Improvement with rationale}
 
## Passed Checks
 
-{List of checks that passed}
 
## Summary
 
{One sentence: ready to publish or what must be addressed first}

When to Use

• Before merging documentation PRs
• Before publishing READMEs to new packages
• Quarterly documentation audits
• After major feature changes

Relationship with docs-review

For combined voice/style and technical verification, load both this skill and the internal:docs-review skill.

When to use each:

• docs-review — Polishing prose, checking tone, improving flow
• docs-check — Quality gate before merge, verifying technical accuracy
• Both — Full documentation audit (load both skills)