spec-audit

Compare spec files against source code and generate audit reports.

4|Updated Jan 12, 2017

Search Tags:#quality assurance #code review #source code analysis #spec-audit #specification comparison

Ready to run

npx skills add https://github.com/brandon-fryslie/dotfiles --skill spec-audit-brandon-fryslie

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: spec-audit
Source: https://github.com/brandon-fryslie/dotfiles/tree/main/config/claude/skills/spec-audit
Command: npx skills add https://github.com/brandon-fryslie/dotfiles --skill spec-audit-brandon-fryslie

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures the accuracy of specification documentation against source code, providing a comprehensive report without modifying the original documents.

Core Features & Use Cases

Read-Only Audit: Produces a findings report without editing the spec files.
In-depth Analysis: Identifies inaccuracies, omissions, and stale claims.
Customization: Supports various scopes and output locations.
Use Case: Use this Skill to verify the spec accuracy for a new feature release, comparing the spec against the source code.

Quick Start

Run the command: `/spec-audit spec-location=/spec/spec-src/*.md source-root=/src/ output-location=.prompts/audit/

Frequently Asked Questions about spec-audit

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

FAQPage Schema

How do I audit specification documentation against source code without modifying the spec files?▼

To audit specification documentation against source code without modifications, use a read-only spec audit tool. It compares spec files directly against the source tree and generates a detailed findings report of inaccuracies or omissions.

What is the best way to identify stale claims and omissions in markdown spec files during code review?▼

Identifying stale claims and omissions in markdown spec files during code review requires automated specification comparison. This process analyzes the source code to validate documentation accuracy and outputs a comprehensive audit report.

Can I generate a quality assurance audit report for a new feature release without altering my version control documents?▼

Yes, you can generate a quality assurance audit report without altering version control documents. A read-only spec audit compares your feature specification against the source code and writes the findings to a separate output location.

How do I run an automated spec audit across a specific source directory?▼

To run an automated spec audit across a specific source directory, execute the audit command by providing the spec file location, the source root directory, and a designated output location for the generated findings report.

Does spec auditing support customized scopes for analyzing source code accuracy?▼

Yes, spec auditing supports customized scopes for analyzing source code accuracy. You can define specific spec locations, source root directories, and output targets to focus the documentation comparison on relevant code paths.