review-doc-quality

star 34

Documentation quality checklist: accuracy, completeness, consistency, and freshness

OzeroHAX By OzeroHAX schedule Updated 2/16/2026

name: review-doc-quality description: Documentation quality checklist: accuracy, completeness, consistency, and freshness

A short quality gate is needed before publishing a document An audit of existing documentation fitness is required Document text or diff Target audience and expected reading outcome Relevant links to product/interfaces/contracts Accuracy: facts, commands, parameters, and examples are correct and reproducible Completeness: prerequisites, main flow, errors, and next steps are covered Consistency: unified terminology, entity naming, and section structure Clarity: text is scannable, steps are short, and each step outcome is clear Freshness: versions, update date, and document owner are specified Accessibility/readability: neutral language, clear labels, minimal ambiguity All P0 items are confirmed Actions and priorities are defined for P1/P2 findings Do not publish a document with non-reproducible commands and examples Do not hide known limitations and caveats Review result: PASS or FAIL List of quality defects with priorities and proposed fixes
Install via CLI
npx skills add https://github.com/OzeroHAX/AssistAgents --skill review-doc-quality
Repository Details
star Stars 34
call_split Forks 7
navigation Branch main
article Path SKILL.md
Occupations
More from Creator