Documentation analysis — assess coverage, detect code-to-doc drift with plan reconcile, visualize dependencies with doc graph. Answers "what needs docs?" and "are docs still accurate?"

indexion documentation — Documentation Analysis Assess documentation state and detect drift. This skill covers the evaluation side of the documentation lifecycle: what exists, what's missing, what's stale. For building READMEs, see indexion readme . "What needs documentation?" Reports: Overall coverage percentage (documented / total pub items) Per package breakdown with README presence Functions vs types coverage split Output example: For a detailed plan with prioritized action items: For a quick per file listing of undocumented items: How detection works: Uses KGF tokenization to find visibility keywords ( pub , public , export ) paired with declaration keywords ( fn , struct , enum , type , trait ). Associates /// doc comments with declarations. Language agnostic — works for any KGF supported language. Caveat: /// marker only comments count as "documented" even without descriptive text. Check doc preview in the output for quality, not just coverage. "Are my docs up to date?" Detect drift between implementation code and documentation. This compares code symbols against documentation and reports: Vocabulary divergence : source code terms missing from co located docs Stale docs : code changed after docs were last updated Missing docs : code modules with no documentation coverage Read the report: The Vocabulary Divergence table shows distance (0 100%) between code vocabulary and documentation. 90%+ distance means the README is essentially unrelated to the current code. Check the Gap Terms column for specific missing vocabulary. Scoped checks: Timestamp strategies: Cache and drift: plan reconcile maintains a cache at .indexion/cache/reconcile/ . After schema changes or indexion upgrades, the cache can become stale and cause deserialization errors. Clear it: "Show me the dependency structure" Generate dependency diagrams for understanding module relationships. Analysis Workflow Common Pitfalls "plan reconcile shows 90%+ divergence everywhere" Auto generated skeleton READMEs (API listing only) have high divergence because they lack the vocabulary of the actual implementation. Enrich them with descriptions of what the code does, not just what it exports. "plan documentation says 100% coverage but docs are wrong" Coverage measures presence of doc comments, not accuracy. A /// marker counts as documented. Use plan reconcile to check content accuracy. "plan reconcile crashes on startup" Cache deserialization error after schema changes. Clear it: rm rf .indexion/cache/reconcile "plan reconcile detects drift I already fixed" The git flag uses commit timestamps. If you fixed docs but haven't committed, mtime based detection ( mtime only ) will see the fix, but git based won't. Reconcile only checks implementation docs direction. It detects code terms missing from docs, but does NOT detect docs referencing nonexistent CLI options. For that direction, compare each README against indexion <command help manually.

indexion-documentation