Skip to main content

Documentation Audit

Comprehensive documentation quality audit with gap identification

Complexity: Moderate | Duration: 15-30m | Category: Developer Experience

Tags: documentation audit quality validation

Workflow Diagram​

Steps​

Step 1: Documentation inventory​

Agent: codi

documentation-writer - List all documentation files

Step 2: Quality checks​

Agent: component

qa-validator - Run markdownlint, link checker

Step 3: Coverage analysis​

Agent: codi

documentation-writer - Identify undocumented features

Step 4: Accuracy verification​

Agent: component

qa-validator - Verify docs match code

Step 5: Issue reporting​

Agent: orchestrator

Generate audit report with issues

Step 6: Remediation plan​

Agent: codi

documentation-writer - Prioritize documentation improvements

Usage​

To execute this workflow:

/workflow developer-experience/documentation-audit.workflow

See other workflows in this category for related automation patterns.