audit-specs

Automates semantic audits of code specifications against library-wide codebases, outputting structured drift reports.

Updated Sep 17, 2019

Search Tags:#code audit #semantic analysis #specification review #codebase verification #library consistency

Ready to run

npx skills add https://github.com/wwlorey/dotfiles --skill audit-specs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: audit-specs
Source: https://github.com/wwlorey/dotfiles/tree/main/.agents/skills/audit-specs
Command: npx skills add https://github.com/wwlorey/dotfiles --skill audit-specs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of running semantic audits on code specifications to ensure they align with the actual code, preventing drift and discrepancies in a library-wide codebase.

Core Features & Use Cases

Semantic Audit: Compare specs against code, detecting inconsistencies and discrepancies.
Scalable Invocation: Run audits scoped to specific stems, entire libraries, or by default for parallelized library-wide checks.
Contextual Verification: Optional 'DIFF_CONTEXT' parameter to scope verification to claims affected by recent code changes.
Output: Generate drift reports with findings, including high, medium, and low severity issues, along with tracker files for MED/LOW issues.

Quick Start

Run the 'audit-specs' skill to automatically compare the project's specs against the code, or specify stems for a scoped audit: audit-specs lsr lsr-app.

Frequently Asked Questions about audit-specs

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

FAQPage Schema

How do I automate code specification audits for library-wide consistency?▼

To automate code specification audits, you run semantic analysis scripts that compare specs against the actual codebase to detect drift and discrepancies. This process validates library-wide consistency and outputs structured drift reports with severity findings.

What is semantic specification review and how does it prevent codebase drift?▼

Semantic specification review is the process of verifying that code specifications align with the actual code in a library. By running automated audits to identify inconsistencies, it prevents drift and ensures documentation matches the implementation.

Can I scope specification verification to only recent code changes?▼

Yes, you can scope specification verification to recent code changes by providing a DIFF_CONTEXT parameter. This contextual verification restricts the semantic audit to only claims affected by the specific changes, optimizing the review process.

Do I need Python to run codebase verification and drift reports?▼

Yes, you need Python scripting and analysis libraries to run codebase verification. The skill requires access to both spec and code repositories to execute the semantic audits and generate structured drift reports with severity findings.

What is the best way to audit code specs across an entire library?▼

The best way to audit code specs across an entire library is to run a default parallelized audit. You can also target specific stems for scoped checks, generating drift reports that categorize inconsistencies into high, medium, and low severity issues.