doc-gaps-audit

Compare codebase implementation against existing prose to record documentation gaps.

2|Updated May 18, 2022
One-click install
npx skills add https://github.com/alexfalkowski/bin --skill doc-gaps-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-gaps-audit
Source: https://github.com/alexfalkowski/bin/tree/main/skills/doc-gaps-audit
Command: npx skills add https://github.com/alexfalkowski/bin --skill doc-gaps-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the challenge of maintaining accurate, high-quality documentation by identifying discrepancies between implementation and prose without the risk of accidental or unauthorized edits.

Core Features & Use Cases

  • Scoped Auditing: Performs targeted reviews of specific packages or folders to ensure documentation coverage.
  • Evidence-Based Reporting: Records findings in a structured ledger format, linking code, tests, and schemas to documentation claims.
  • Workflow Integration: Acts as a precursor to the doc-gaps-fix skill, ensuring that only validated and confirmed gaps are queued for resolution.

Quick Start

Initiate a documentation audit for the current directory by requesting an audit of the target folder without applying any changes.

Frequently Asked Questions about doc-gaps-audit

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

FAQPage Schema
What is a documentation gap analysis against a codebase?

You can perform a documentation gap analysis by comparing your codebase implementation directly against existing prose. This process generates a structured audit ledger detailing where your technical writing fails to match the actual code.

How do I audit technical documentation for missing coverage?

You audit technical documentation for missing coverage by initiating a scoped review of a specific target folder or package. The audit compares the implementation against existing prose and records the findings in a structured ledger without applying any changes.

Can I check documentation compliance without modifying my source files?

You can check documentation compliance without modifying source files because the audit process only identifies and records gaps. It operates within defined project scopes to generate a remediation ledger, ensuring your codebase remains untouched.

What is the best way to track documentation discrepancies for remediation?

The best way to track documentation discrepancies for remediation is to generate an evidence-based structured audit ledger. This ledger links code, tests, and schemas directly to documentation claims, creating a validated queue for subsequent fixes.

Does a documentation gap audit automatically fix the missing prose?

A documentation gap audit does not automatically fix the missing prose. It acts as a precursor to remediation by validating and confirming gaps, routing them to a separate fixing process to ensure consistent quality and prevent unauthorized edits.