@aiready/doc-drift

AIReady Spoke: Tracks documentation freshness versus code churn.

Overview

The Documentation Drift analyzer combines AST parsing with git log traversal to identify instances where comments are likely lagging behind actual implementation logic.

Language Support

• Full Support: TypeScript, JavaScript, Python, Java, Go, C#
• Capabilities: JSDoc/Docstring/XML-Doc drift detection, signature mismatch. toxicology

🏛️ Architecture

                    🎯 USER
                      │
                      ▼
         🎛️  @aiready/cli (orchestrator)
          │     │     │     │     │     │     │     │     │
          ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼     ▼
        [PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST]
          │     │     │     │     │     │     │     │     │
          └─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
                               │
                               ▼
                      🏢 @aiready/core

Legend:
  PAT = pattern-detect        CTX = context-analyzer
  CON = consistency           AMP = change-amplification
  DEP = deps-health           DOC = doc-drift ★
  SIG = ai-signal-clarity     AGT = agent-grounding
  TST = testability           ★   = YOU ARE HERE

Features

• Drift Detection: Detects documentation older than the code it describes based on git history timestamps.
• Signature Mismatches: Finds missing documented @param tags when new arguments are added.

Installation

pnpm add @aiready/doc-drift

Usage

aiready scan . --tools doc-drift

License

MIT