update-stale-docs

Identify documentation affected by code changes across memory, ABOUTME, inline diffs, decision docs, and README notes.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/seankao31/dotfiles --skill update-stale-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-stale-docs
Source: https://github.com/seankao31/dotfiles/tree/main/agent-config/skills/update-stale-docs
Command: npx skills add https://github.com/seankao31/dotfiles --skill update-stale-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation in projects often becomes stale after changes, leading misalignment between code and guidance. This skill provides a structured checklist to surface and refresh all affected docs across memory, ABOUTME pages, inline diffs, decision documents, and README notes as part of the same unit of work.

Core Features & Use Cases

  • Scans and validates ABOUTME comments for current relevance relative to code.
  • Audits inline diff notes, decision docs, memory entries, and README guidance to surface inconsistencies.
  • Guides teams to update documentation in a single cohesive sweep before committing changes with traceable history.

Quick Start

Run the update-stale-docs checklist after completing a feature to refresh all impacted docs.

Frequently Asked Questions about update-stale-docs

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

FAQPage Schema
How do I keep documentation fresh after making code changes?

To keep documentation fresh after code changes, run a structured checklist that cross-checks ABOUTME tags, inline diff comments, decision docs, memory entries, and README notes to surface inconsistencies before committing.

What is the best way to find stale documentation affected by recent commits?

Finding stale documentation affected by recent commits involves scanning inline diff notes, memory entries, and decision docs to audit current relevance, ensuring a comprehensive doc sweep that highlights inconsistencies for update.

How do I update ABOUTME tags and memory entries before a commit?

Update ABOUTME tags and memory entries before a commit by performing a cohesive doc sweep that validates their relevance against code changes, prompting necessary refreshes to maintain alignment across all sources.

When should I run a documentation review sweep for code maintenance?

Run a documentation review sweep for code maintenance immediately after completing a feature, ensuring all impacted docs including README guidance and decision documents are refreshed as part of the same unit of work.

Does updating stale docs require any external dependencies?

Updating stale docs requires no external dependencies, applying directly to existing workflows that involve code changes and ongoing maintenance across memory, ABOUTME tags, inline diffs, decision docs, and README notes.