---
name: Quality Checking
slug: quality-checking
category: Quality
description: Quality Checking validates generated API documentation against a standards checklist. Use it to confirm routes, structure, auth markers, examples, and source matches are correct.
github: "https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/08-skill-pipeline/.claude/skills/quality-checking"
language: JavaScript
stars: 1077
forks: 379
install: "npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/08-skill-pipeline/.claude/skills/quality-checking ~/.claude/skills/quality-checking"
installs_to: ~/.claude/skills/quality-checking
source_path: 04-Skills/projects/08-skill-pipeline/.claude/skills/quality-checking/SKILL.md
collection_size: 13
category_size: 1354
collection_url: "https://dirskills.com/collections/huangjia2019/claude-code-engineering"
added: 2026-08-21T05:13:31.351Z
last_synced: 2026-08-21T05:13:31.351Z
canonical_url: "https://dirskills.com/skills/quality-checking"
---

# Quality Checking

Quality Checking validates generated API documentation against a standards checklist. Use it to confirm routes, structure, auth markers, examples, and source matches are correct.

**Install:**

```bash
npx degit https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/08-skill-pipeline/.claude/skills/quality-checking ~/.claude/skills/quality-checking
```

## README

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