本文へ移動
cccskills
無料GitHub で公開

quality-checking

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

インストール方法を見る

含まれるファイル(2)

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

SKILL.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:

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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

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.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

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.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

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

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

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.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

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.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

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.

日本語の概要は準備中です。原文の説明を表示しています。

huangjia2019/claude-code-engineering1,1352026年7月23日 更新

huangjia2019 のスキルをすべて見る

このスキルの問題を報告する