repo-doc-auditor

Audit repository documentation against code and recent changes.

Updated Dec 20, 2025
One-click install
npx skills add https://github.com/ogprotege/Skills --skill repo-doc-auditor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-doc-auditor
Source: https://github.com/ogprotege/Skills/tree/main/Categories/Documentation/repo-doc-auditor
Command: npx skills add https://github.com/ogprotege/Skills --skill repo-doc-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Repo Documentation Auditor provides repo-wide, evidence-based validation that documentation accurately reflects the current code and recent changes. It outputs a fully proposed documentation set in a review-only folder and never overwrites live docs without explicit approval.

Core Features & Use Cases

  • Evidence-based auditing: Verifies docs against code, config, tests, and commits.
  • Non-destructive output: Writes to TempDoc-ForUserReview/ for review only.
  • Plan-first workflow: Generates a plan or complete draft for user review.
  • Use Case: Before a major release, run repo-doc-auditor to ensure API docs and runbooks match the latest code changes.

Quick Start

Use repo-doc-auditor with Scope: entire repository, Target branch: main, Mode: plan + debug to generate a review-ready doc set.

Frequently Asked Questions about repo-doc-auditor

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

FAQPage Schema
How do I audit documentation against my codebase to find outdated content?

Documentation auditing validates docs against current code, configurations, tests, and commits to identify drift. The repo-doc-auditor scans your repository, compares documentation to implementation, and generates a proposed rewrite in a review-only folder without modifying live docs.

Can I review proposed documentation changes before they're applied to my repository?

Yes. The Skill outputs all changes to TempDoc-ForUserReview/ for review-only inspection. You can examine the full proposed documentation set, compare it against your live docs, and approve changes explicitly before they're written to your repository.

What's the best way to ensure documentation stays in sync with recent code changes?

Run documentation auditing before releases using plan-first mode with Git diff review. This generates a plan and complete draft anchored to evidence from code, tests, and commits, catching documentation drift before deployment and ensuring accuracy.

Can I audit documentation for only specific folders or branches instead of the entire repository?

Yes. The Skill supports scoped auditing by folder, subtree, or release target. You can define the scope and target branch, then generate a plan or debug output tailored to that portion of your codebase.

How does the Skill handle documentation sections it cannot fully verify?

Unverifiable claims are labeled 'Needs confirmation' with open questions, ensuring traceability. Every audit assertion is anchored to evidence from code, configurations, and tests, so incomplete verifications remain transparent and reviewable.

Do I need version control integration to run documentation audits?

Yes. The Skill reads code, configurations, tests, and commit history to audit documentation accuracy. Git integration allows it to track recent changes and compare documentation against the target branch you specify.