documentation-audit

Audit repository documentation for drift and generate a severity-rated log.

2|Updated Apr 8, 2026

Search Tags:#templates #documentation #audit #drift #log #broken-links

Ready to run

npx skills add https://github.com/DojoGenesis/gateway --skill documentation-audit-dojogenesis

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-audit
Source: https://github.com/DojoGenesis/gateway/tree/main/plugins/system-health/skills/documentation-audit
Command: npx skills add https://github.com/DojoGenesis/gateway --skill documentation-audit-dojogenesis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation drift erodes clarity by producing outdated information, broken links, and missing sections across project docs.

Core Features & Use Cases

Audit multiple documents (README.md, ARCHITECTURE.md, CHANGELOG.md, and SKILL.md) and produce a structured audit log with severity ratings and actionable items.
Reference an audit-log template to ensure consistent reporting and traceability.
Integrate into onboarding and release processes to keep docs in sync with code.

Quick Start

Run a full documentation audit on the target repository to generate a drift report.

Frequently Asked Questions about documentation-audit

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

FAQPage Schema

How do I audit documentation drift in a repository?▼

Run a full documentation audit on your target repository to quantify drift. It identifies outdated information, broken links, and missing sections across key docs like README.md and ARCHITECTURE.md, producing a committed severity-annotated log with a summary.

What is documentation drift and how do I quantify it?▼

Documentation drift occurs when project docs contain outdated information and broken links. This skill quantifies drift by scanning files like CHANGELOG.md and SKILL.md, producing a structured audit log with severity ratings and actionable items.

How do I check for broken links and missing sections in markdown files?▼

You can check for broken links and missing sections by running this audit skill across your markdown files. It references an audit-log template to ensure consistent reporting and outputs a comprehensive severity-annotated log.

Can I integrate a documentation audit into my release process?▼

Yes, you can integrate a documentation audit into onboarding and release processes to keep docs in sync with code. It generates a committed audit log with severity ratings and a summary to track documentation health.

What is the best way to generate a severity-annotated audit log for project docs?▼

The best way to generate a severity-annotated audit log is to run a full documentation audit on your repository. It references an audit-log template to ensure consistent reporting and outputs a committed log with a summary.

Do I need any dependencies to run a documentation audit?▼

No, you do not need any dependencies to run this documentation audit. It operates without external dependencies and references an internal audit-log template to produce a structured drift report with severity ratings.