skills.rest
ousiass
ousiassCOMMUNITY
Explore all skills by this author →
GitHub

spec-audit-en

Audit spec documents against codebases and generate GitHub Issues.

Updated May 3, 2026
Search Tags:#openapi#implementation verification#issue creation#api schema#spec audit#skipped tests#todo detection
One-click install
npx skills add https://github.com/ousiass/dotfiles --skill spec-audit-en
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: spec-audit-en
Source: https://github.com/ousiass/dotfiles/tree/main/.claude/skills/spec-audit-en
Command: npx skills add https://github.com/ousiass/dotfiles --skill spec-audit-en

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It helps you detect when implementation lags behind your spec by identifying unimplemented endpoints/features, lingering TODOs, skipped tests, and mismatches in API schema so you can create clear GitHub Issues.

Core Features & Use Cases

  • Spec vs Implementation Gap Detection: Verifies that spec-defined features, endpoints, and behaviors exist in code, reporting mismatches with both spec-side and implementation-side locations.
  • Code Quality & Test Integrity Checks: Finds TODO/FIXME/HACK markers and detects skipped tests across common languages to surface incomplete or intentionally disabled work.
  • API Schema Gap Auditing: Compares OpenAPI/Swagger definitions against actual handlers to flag endpoints defined in schemas but missing in implementation.
  • Issue & Report Output: Aggregates findings into a formatted report and, with approval, creates GitHub Issues (single combined or individual per finding).

Quick Start

Run spec-audit-en without arguments to auto-discover documents and generate a gap report ready for GitHub Issue creation.

Frequently Asked Questions about spec-audit-en

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find unimplemented endpoints between an OpenAPI schema and my codebase?▼

Spec audit compares your OpenAPI definitions against actual handlers to find API schema gaps. It verifies spec-defined endpoints exist in code, flagging mismatches with concrete file and line evidence.

What is the best way to detect lingering TODO markers and skipped tests systematically?▼

Detecting TODO markers and skipped tests is done by scanning the codebase for incomplete work. This process finds TODO, FIXME, and HACK markers across common languages and surfaces intentionally disabled tests.

How do I automatically create GitHub Issues for spec vs implementation gaps?▼

You can create GitHub Issues for implementation gaps by aggregating audit findings into a formatted report. With approval, it generates either a single combined issue or individual issues per finding.

Can I audit CLI arguments and config environment usage against spec files?▼

Yes, you can audit CLI arguments and config usage against spec files. The audit systematically checks endpoints, functions, CLI arguments, config/env usage, and data model claims for discrepancies.

What are the limitations of using a spec audit for implementation verification?▼

Spec audit limitations require repositories to maintain authoritative spec files. It depends on discovering targets via globbing rules and verifying findings using grep, meaning it needs explicit spec documents to function.

Does spec audit work with repositories lacking authoritative spec files?▼

Spec audit does not work well without authoritative spec files. It requires discovering targets via globbing rules and verifying findings against implementation code, making authoritative specs a prerequisite.

Related Skills

Explore More Software Engineering Skills→
liutao96liutao96

lark-openapi-explorer

Extract OpenAPI endpoint details from official Lark Markdown documents for lark-cli api invocation.

Community
Intermediate
ZodomoZodomo
7

audit

Audit EVM smart contracts and file GitHub issues for medium-or-higher findings.

Community
Advanced
ze-softwareze-software
50

ze-audit

Audit Ze specs against the codebase and report Done/Partial/Missing statuses with file:line evidence.

Official
Intermediate
Chang-Shih-YungChang-Shih-Yung

health

Aggregate type checker, linter, and test results into a 0-10 composite score.

Community
Advanced