@aiready/doc-drift
v0.1.10
Published
AI-Readiness: Documentation Drift Detection
Readme
@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.
🏛️ 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 HEREFeatures
- Drift Detection: Detects documentation older than the code it describes based on git history timestamps.
- Signature Mismatches: Finds missing documented
@paramtags when new arguments are added.
Installation
pnpm add @aiready/doc-driftUsage
aiready scan . --tools doc-driftLicense
MIT
