Skip to content
cccskills
FreePublished on GitHub

quality-checking

Validate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.

The English summary is being prepared. Showing the original description.

See how to install

Files included (2)

  • SKILL.md1.5 KB
  • rules/doc-standards.md1.0 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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:

# 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}

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

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.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

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.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.

The English summary is being prepared. Showing the original description.

huangjia2019/claude-code-engineering1.1KUpdated Jul 23, 2026

See all skills by huangjia2019

Report a problem with this skill