quality-checking
This skill validates generated API documentation against standardized quality criteria by checking completeness, structure, authentication markers, JSON examples, and format consistency. Use it after documentation generation to ensure all documented routes match the source code, contain required sections like method and parameters, and meet formatting standards before deployment.
git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering /tmp/quality-checking && cp -r /tmp/quality-checking/04-Skills/projects/08-skill-pipeline/.claude/skills/quality-checking ~/.claude/skills/quality-checkingSKILL.md
# 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}%
## Issues Found
{list each issue with file, line, and description}
## Verdict
{PASS: all checks passed / NEEDS_REVISION: list what needs fixing}
```Deep analysis of code against project standards
API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.
Generate comprehensive API documentation by scanning Express route files.
Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
Explore and analyze API-related code. Use when investigating endpoints, routing, or HTTP handling.
Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
Explore and analyze authentication-related code. Use when investigating auth flows, session management, or security.
Analyze root cause of bugs after location is identified. Second step in bug investigation.