doc-audit

Audit Rust project documentation against source code for consistency.

Updated Feb 27, 2026

Search Tags:#consistency #audit #Rust #code documentation #source code analysis

Ready to run

npx skills add https://github.com/wutongshenqiu/prism --skill doc-audit-wutongshenqiu

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the process of ensuring that documentation stays in sync with source code, saving time and reducing errors in development.

Core Features & Use Cases

Automated Documentation Consistency: Audit documentation against codebase for discrepancies.
Multiple Scopes: Supports quick checks, full audits, and specific scopes like API, agents, and specs.
Fix on the Fly: Auto-fix discrepancies discovered during audits with the --fix option.
Use Case: Regularly check your project's AGENTS.md, specs/completed/ files, and reference/ to ensure that the documentation accurately reflects the source code.

Quick Start

Perform a quick documentation consistency check with the doc-audit skill using the command: 'doc-audit quick'.

Frequently Asked Questions about doc-audit

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

FAQPage Schema

How do I check documentation consistency against Rust source code?▼

To check documentation consistency against Rust source code, run an automated audit using the doc-audit command. It scans documentation files like AGENTS.md and reference directories to identify discrepancies with the actual codebase.

Can I automatically fix documentation discrepancies in a Rust project?▼

You can automatically fix documentation discrepancies by running the audit command with the --fix flag. This option auto-corrects inconsistencies discovered during the scan of your API endpoint tables and specs.

What is the best way to audit specific scopes like API endpoints and specs?▼

The best way to audit specific scopes like API endpoints and specs is to use targeted audit commands. This approach scans only the selected reference files or AGENTS.md instead of running a full project audit.

How do I perform a quick documentation consistency check?▼

Perform a quick documentation consistency check by executing the doc-audit quick command. This rapidly verifies that your reference types and completed spec files accurately reflect the source code.

Does the documentation audit work with AGENTS.md files?▼

Yes, the documentation audit works with AGENTS.md files by explicitly checking them against the source code. It ensures that the agent instructions and references remain synchronized with the actual Rust implementation.