scan-docs-drift

Compare code changes against READMEs to detect documentation drift.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/TrevorPLam/agency --skill scan-docs-drift
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scan-docs-drift
Source: https://github.com/TrevorPLam/agency/tree/main/.windsurf/skills/scan-docs-drift
Command: npx skills add https://github.com/TrevorPLam/agency --skill scan-docs-drift

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detects stale or drifted documentation by comparing recent code changes to corresponding READMEs, helping teams maintain alignment between implementation and documentation.

Core Features & Use Cases

  • Identify code changes and locate outdated docs across packages and projects.
  • Generate drift reports and actionable issues for documentation reviews and releases.
  • Support ongoing maintenance by surfacing mismatches between code and documentation updates.

Quick Start

Run the drift scan after code or docs changes to surface mismatches between implemented code and documentation.

Frequently Asked Questions about scan-docs-drift

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect documentation drift between my code and README files?

To detect documentation drift, you can scan your repository's git history to compare recent code changes against corresponding READMEs. This surfaces stale documentation mismatches across packages and apps, generating a structured drift report for issue tracking.

What is the best way to audit stale documentation before a software release?

The best way to audit stale documentation before a release is to scan code changes and locate outdated docs across packages. Comparing implementation updates against READMEs ensures alignment and generates actionable issues for documentation reviews.

How do I generate a drift report for outdated docs in my git repository?

You can generate a drift report by running a scan that requires access to git history within your repository. It operates on docs and code references to identify mismatches, outputting a structured report of outdated documentation for ongoing maintenance.

Does documentation drift detection work across multiple packages and apps?

Yes, documentation drift detection works across multiple packages and apps. It identifies code changes and locates outdated docs throughout your project structure, ensuring alignment between implementation and documentation updates during software reviews.

When do I need to scan for documentation drift in my project?

You need to scan for documentation drift during software documentation reviews, release planning, and ongoing maintenance. Running the scan after code or docs changes surfaces mismatches between implemented code and documentation to prevent stale references.

Why does my README no longer match the recent code changes in my repository?

Your README no longer matches recent code changes due to documentation drift. By comparing git history against your docs, you can identify exactly where implementation updates occurred without corresponding documentation updates across your packages.