Quality checking
This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库，目标就是： 👉 把 Claude Code 从“对话式编码工具”，变成 可设计、可复用、可治理的工程系统。
npx -y skills add huangjia2019/claude-code-engineering --skill quality-checkingAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
What its author says it does
Copied from the file, not written here
Validate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.
SKILL.md
1.5 KB, as published. Nobody here has run it
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:
- 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}