quality-checking
Validate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.
npx skills add huangjia2019/claude-code-engineering --skill quality-checking --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# Quality Checking Skill Validate generated API documentation against quality standards. ## Input You will receive a documentation manifest from the previous pipeline stage, listing generated files and documented routes. ## Process ### Step 1: Load Quality Rules Read the rules at `rules/doc-standards.md` for the complete checklist. ### Step 2: Check Each Documentation File For each generated doc file, verify: 1. **Completeness**: Every route from the scanner manifest is documented 2. **Structure**: Each endpoint has method, path, description, parameters, responses 3. **Auth markers**: Endpoints with auth middleware have 🔒 markers 4. **Examples**: Request/response examples are valid JSON 5. **Consistency**: All files follow the same format ### Step 3: Cross-Reference with Source For each documented endpoint, spot-check against the source file: - Does the documented path match the actual route? - Are the middleware requirements correctly noted? - Are the response codes accurate? ## Output Format Return a quality report: ```markdown # Documentation Quality Report ## Score: {PASS / NEEDS_REVISION} ## Coverage - Routes in manifest: {N} - Routes documented: {N} - Coverage: {percentage}%
- Input
- Process
- Step 1: Load Quality Rules
- Step 2: Check Each Documentation File
- Step 3: Cross-Reference with Source
- Output Format
What does the quality-checking skill do?
Validate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.
How do I install it?
Run `npx skills add huangjia2019/claude-code-engineering --skill quality-checking --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From huangjia2019/claude-code-engineering, a repository with 1,040 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.
