quality-checking
npx machina-cli add skill huangjia2019/claude-code-engineering/quality-checking --openclawQuality 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:
- Completeness: Every route from the scanner manifest is documented
- Structure: Each endpoint has method, path, description, parameters, responses
- Auth markers: Endpoints with auth middleware have 🔒 markers
- Examples: Request/response examples are valid JSON
- 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:
# Documentation Quality Report
## Score: {PASS / NEEDS_REVISION}
## Coverage
- Routes in manifest: {N}
- Routes documented: {N}
- Coverage: {percentage}%
## Issues Found
{list each issue with file, line, and description}
## Verdict
{PASS: all checks passed / NEEDS_REVISION: list what needs fixing}
Source
git clone https://github.com/huangjia2019/claude-code-engineering/blob/main/04-Skills/projects/08-skill-pipeline/.claude/skills/quality-checking/SKILL.mdView on GitHub Overview
Quality-checking validates generated API documentation against a defined quality standards checklist. It ensures every route is documented, the documentation structure is consistent, auth markers are present, examples are valid JSON, and the docs align with the actual source code.
How This Skill Works
Process: Load the quality rules from rules/doc-standards.md, then iterate the documentation manifest. For each file, check completeness, ensure required fields exist (method, path, description, parameters, responses), validate authentication markers for protected routes, confirm JSON examples are valid, and enforce a uniform format. Finally, cross-check documented endpoints against the source to verify paths, middleware, and response codes.
When to Use It
- After generating API docs from your codebase to ensure full coverage
- When endpoints or middleware change and docs must reflect those updates
- Before release to verify documentation quality and consistency
- During a documentation refactor to enforce a single format
- When auditing multiple services for standardization across teams
Quick Start
- Step 1: Gather the documentation manifest from the previous pipeline stage
- Step 2: Run quality-checking to produce a Documentation Quality Report
- Step 3: Review issues, fix docs or source, and re-run
Best Practices
- Anchor checks to a single rules file at rules/doc-standards.md
- Run checks automatically against the documented manifest and source
- Require completeness, structure, auth markers, and valid JSON examples
- Enforce a consistent format across all files for easy review
- Review and fix issues with clear file and line references
Example Use Cases
- Audit a generated API docs manifest to ensure every route is documented
- Check that protected endpoints include 🔒 markers and correct middleware notes
- Cross-reference documented routes with actual router definitions in the source
- Validate that request/response examples are valid JSON and representative
- Generate and review the Documentation Quality Report prior to release
