repo-doc-audit

You can audit repository documentation by running a comprehensive health check across docstrings, READMEs, architecture references, and script conventions to identify gaps and generate a prioritized action plan for fixes.

A repository documentation health audit is a targeted assessment that identifies gaps, inconsistencies, and outdated information across README files, architecture notes, docstrings, and scripting conventions to improve codebase onboarding.

To check README accuracy after a refactor, audit the repository to validate that commands, setup steps, and troubleshooting sections align with the actual codebase structure and generate suggested edits.

Yes, you can validate architecture and component references by auditing the repository to ensure documentation accurately reflects the actual repository structure and component relationships.

Yes, this documentation audit is designed for codebases undergoing refactors, restructures, or onboarding new contributors, providing a prioritized action plan to improve script and module docstring clarity.

The best way to generate a documentation action plan is to perform a repository-wide audit that identifies inconsistencies and produces a prioritized report with suggested fixes for README and architecture alignment.