cyberneticlibrary

Find documentation vs code drift

doc-driftworkflowsetup L33
gaborage/go-bricks
What it does

Detect documentation and code-comment drift via adversarial review

Best for

Finding documentation and comments that have drifted from current code before releases or after large refactors.

Inputs
  • · git repo (implicit cwd)
Outputs
  • · ranked markdown drift report
  • · doc findings: concrete claims vs code (verified, contradicted, stale)
  • · comment findings: stale/redundant comments per code cluster
  • · prioritized recommendations
Requires
  • · git CLI (file enumeration, blame history)
  • · bash grep/sed for file discovery
  • · parallel agent fleet (review clusters, adversarial verify)
Preconditions
  • · git repo initialized with tracked docs
  • · non-test Go files present
  • · git history available for blame/age analysis
Failure modes
  • · No tracked docs found → report is comment-only
  • · Agent review times out on large code cluster → finding skipped (non-fatal)
  • · Adversarial verify rejects finding → finding demoted or rejected (conservative)
  • · Comment language ambiguous → agent flags as uncertain, ranked lower
Trust signals
  • · Adversarial verify phase challenges each finding before ranking (anti-false-positive)
  • · Ranked report (highest drift severity first) guides prioritization
  • · Read-only design: produces report, never edits
  • · Comment staleness detected via code cluster analysis + temporal patterns