What problem does it solve?
Technical documentation often drifts out of sync with the actual codebase, containing references to classes, methods, or configuration items that no longer exist or behave differently. This Skill provides a structured audit workflow that cross-validates docs against real code and fixes inconsistencies.
Core Features & Use Cases
- Code Reference Verification: Extracts class names, method names, and file paths from documentation and verifies their existence in the actual Java/XML codebase using grep-based searches.
- Behavior Consistency Checks: Compares documented behavior (parameters, return values, config defaults) against actual code implementations.
- Cross-Document Validation: Checks that multiple documents describe the same concept consistently and that internal links and index routing are valid.
- Prioritized Fix Reports: Generates audit reports classifying issues as High (nonexistent descriptions), Medium (behavior mismatches), or Low (missing information).
- Use Case: When auditing the nop-orm module documentation, the Skill verifies that every entity, field, and configuration item mentioned in docs-for-ai/ actually exists in the *.orm.xml files and Java sources, then produces a fix list.
Quick Start
Ask the AI to audit the documentation for a specific module, for example: run a doc audit on the nop-auth module and verify all code references in its docs.
