doc-audit

The doc-audit skill is a sophisticated maintenance tool designed for software engineering teams using Packmind to govern their architectural standards and engineering playbooks. It ensures that end-user documentation located in apps/doc/ remains synchronized with the evolving reality of the codebase. By performing a multi-phase structural analysis, this skill identifies technical debt within documentation, specifically targeting issues that arise when code changes outpace manual content updates. It is intended for use by technical leads, documentation maintainers, and developer experience engineers who need to ensure high-quality, reliable documentation before project releases or as part of a regular health-check cadence.

• Automated ground truth extraction from docs.json, CLI command definitions, and package directories.

• Parallelized exploration agents that audit documentation sections including Getting Started, Concepts, Tools, Integrations, Governance, and Administration.

• Detection of broken internal MDX links, stale CLI command references, non-existent architectural concepts, and misleading technical information.

• Identification of missing documentation coverage by comparing active source domains and CLI commands against documented pages.

• Generation of a centralized, structured markdown report (doc-audit-report.md) categorized by severity (ERROR, WARNING, INFO).

• Deduplication and severity-based sorting of findings to prioritize critical documentation failures.

• The skill provides detection only and does not attempt to modify MDX files directly, ensuring the audit process remains non-destructive.

• Ensure the repository structure matches the expected apps/doc/ and apps/cli/src/infra/ paths for accurate cross-referencing.

• Useful for CI/CD pipeline triggers, release readiness checks, and post-refactoring documentation maintenance.

• The generated output includes a summary table and detailed findings, making it ideal for integration into Pull Request comments or automated status checks.

• The ground truth phase acts as a safeguard to ensure the audit is always performed against the current state of the application source, not a cached or stale version.