What problem does it solve? Project documentation drifts out of sync with code: READMEs reference deleted scripts, ADRs go stale, public APIs ship undocumented, and broken links accumulate. This Skill audits a TypeScript project's documentation against an opinionated four-layer baseline and produces a structured findings report plus an optional implementation plan. ## Core Features & Use Cases - Four-layer audit: Covers project entry and onboarding (README, LICENSE, .env.example), architectural and decision docs (ADRs, diagrams, per-feature READMEs), code-level docs (TSDoc/JSDoc coverage, TODO hygiene, commented-out code), and operational docs with drift detection (deployment, rollback, monitoring, link resolution). - Static-first with optional enrichment: Read-only by default; internal links are always checked against the file system, and --with-link-check optionally HEAD-requests external URLs. - Structured outputs: Writes findings.md, findings.json (schema 2.0.0), snapshot.md, and metadata.json to .architect-audits/documentation-audit/, then offers to generate a prioritized implementation plan. - Use Case: Run /documentation-audit --with-link-check on a TypeScript monorepo before a release to catch README commands referencing removed package.json scripts, stale TODOs older than 90 days, and broken external links, then generate a remediation plan ordered by audience. ## Quick Start Ask the AI to run the documentation audit on this repository with default settings and then generate an implementation plan for the gaps it finds.
