quality-checking
starsforks
How to install quality-checking?
huangjia2019/claude-code-engineering/quality-checking
$npx -y skills add huangjia2019/claude-code-engineering --skill quality-checkingValidate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.
SKILL.md
| 1 | # Quality Checking Skill |
| 2 | |
| 3 | Validate generated API documentation against quality standards. |
| 4 | |
| 5 | ## Input |
| 6 | |
| 7 | You will receive a documentation manifest from the previous pipeline stage, |
| 8 | listing generated files and documented routes. |
| 9 | |
| 10 | ## Process |
| 11 | |
| 12 | ### Step 1: Load Quality Rules |
| 13 | |
| 14 | Read the rules at `rules/doc-standards.md` for the complete checklist. |
| 15 | |
| 16 | ### Step 2: Check Each Documentation File |
| 17 | |
| 18 | For each generated doc file, verify: |
| 19 | |
| 20 | 1. **Completeness**: Every route from the scanner manifest is documented |
| 21 | 2. **Structure**: Each endpoint has method, path, description, parameters, responses |
| 22 | 3. **Auth markers**: Endpoints with auth middleware have 🔒 markers |
| 23 | 4. **Examples**: Request/response examples are valid JSON |
| 24 | 5. **Consistency**: All files follow the same format |
| 25 | |
| 26 | ### Step 3: Cross-Reference with Source |
| 27 | |
| 28 | For each documented endpoint, spot-check against the source file: |
| 29 | - Does the documented path match the actual route? |
| 30 | - Are the middleware requirements correctly noted? |
| 31 | - Are the response codes accurate? |
| 32 | |
| 33 | ## Output Format |
| 34 | |
| 35 | Return a quality report: |
| 36 | |
| 37 | ```markdown |
| 38 | # Documentation Quality Report |
| 39 | |
| 40 | ## Score: {PASS / NEEDS_REVISION} |
| 41 | |
| 42 | ## Coverage |
| 43 | - Routes in manifest: {N} |
| 44 | - Routes documented: {N} |
| 45 | - Coverage: {percentage}% |
| 46 | |
| 47 | ## Issues Found |
| 48 | {list each issue with file, line, and description} |
| 49 | |
| 50 | ## Verdict |
| 51 | {PASS: all checks passed / NEEDS_REVISION: list what needs fixing} |
| 52 | ``` |
People who liked this also viewed
6 picksType
- tddSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- test-driven-developmentUse when implementing any feature or bugfix, before writing implementation codeSkillsJul 2026
- qaSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- verification-before-completionUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidenceSkillsJul 2026
- webapp-testingToolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser lSkillsJul 2026
- playwright-best-practicesUse when writing Playwright tests, fixing flaky tests, debugging failures, implementing Page Object Model, configuring CI/CD, optimizing performance, mocking APIs, handling authentication or OAuth, teSkillsJul 2026
