Skip to content
Back to skills

Quality Checking

ASecurity

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

  • 1,089 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added September 6, 2026
ai-agentsapidocumentation

Works with

  • api

Security analysis

A100/100

Pro scans all 2 files and shows the line behind each finding

Scanned September 6, 2026

npx -y skills add huangjia2019/claude-code-engingeering --skill quality-checking --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Quality Checking?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Quality Checking
[![Security: A β€” Skills Directory](https://www.skillsdirectory.com/api/skills/huangjia2019-quality-checking-claude-code-engineering/badge)](https://www.skillsdirectory.com/skills/huangjia2019-quality-checking-claude-code-engineering)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: quality-checking
description: Validate API documentation against quality standards. Use when you need to verify generated docs are complete and correct.
allowed-tools: [Read, Grep, Glob]
---

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

Files in this skill

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

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.