Skip to content

borghei/Claude-Skills / engineering/doc-drift-detector

doc-drift-detector

Verified

Detect documentation drift against code changes, score staleness, validate API docs via AST parsing, and audit link integrity. Use when docs fall out of sync with code, preparing releases, running CI doc gates, or auditing doc accuracy.

assets/drift_report_template.md

View on GitHub
# Documentation Drift Report

**Repository:** {{repository_path}}
**Scan Date:** {{scan_date}}
**Generated By:** doc-drift-detector v2.0.0

---

## Summary

| Metric | Value |
|--------|-------|
| Documentation files scanned | {{total_docs}} |
| Files with drift detected | {{drifted_docs}} |
| Overall staleness score | {{overall_score}}/100 |
| Broken links found | {{broken_links}} |
| API mismatches found | {{api_mismatches}} |

## Staleness Scores

| File | Score | Last Updated | Status |
|------|-------|-------------|--------|
| {{file_name}} | {{score}}/100 | {{last_updated}} | {{status}} |

## Drift Issues

### High Severity

| File | Issue | Category | Fix Type |
|------|-------|----------|----------|
| {{file}} | {{description}} | {{category}} | {{fix_type}} |

### Medium Severity

| File | Issue | Category | Fix Type |
|------|-------|----------|----------|
| {{file}} | {{description}} | {{category}} | {{fix_type}} |

### Low Severity

| File | Issue | Category | Fix Type |
|------|-------|----------|----------|
| {{file}} | {{description}} | {{category}} | {{fix_type}} |

## Auto-Fixable Issues

The following issues can be fixed automatically:

- [ ] {{auto_fix_description}} in `{{file}}`

## Manual Review Required

The following issues require human judgment:

- [ ] {{manual_fix_description}} in `{{file}}`

## Recommendations

1. {{recommendation}}

---

## Score Breakdown

| Dimension | Weight | Score | Weighted |
|-----------|--------|-------|----------|
| Last Updated | 20% | {{updated_score}} | {{updated_weighted}} |
| Code-Doc Alignment | 30% | {{alignment_score}} | {{alignment_weighted}} |
| Link Health | 15% | {{link_score}} | {{link_weighted}} |
| Completeness | 20% | {{completeness_score}} | {{completeness_weighted}} |
| Accuracy | 15% | {{accuracy_score}} | {{accuracy_weighted}} |
| **Total** | **100%** | | **{{total_score}}** |

---

*Generated by [doc-drift-detector](../SKILL.md)*
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall