skills.rest
akaszubski
akaszubskiCOMMUNITY
Explore all skills by this author →
GitHub

documentation-currency

Detect stale documentation and version lag in Markdown files.

32|5|Updated Oct 19, 2025
Search Tags:#automation#documentation#version control#roadmap#accuracy#staleness#todo
One-click install
npx skills add https://github.com/akaszubski/autonomous-dev --skill documentation-currency
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-currency
Source: https://github.com/akaszubski/autonomous-dev/tree/main/plugins/autonomous-dev/skills/documentation-currency
Command: npx skills add https://github.com/akaszubski/autonomous-dev --skill documentation-currency

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often becomes stale, with outdated status markers, old "TODOs," and "coming soon" claims that are no longer relevant. This erodes trust and wastes developer time. This skill identifies and flags these issues, ensuring your project's knowledge base is always current.

Core Features & Use Cases

  • Stale Status Detection: Flags "CRITICAL ISSUE" markers for problems that have been solved or "TODOs" for features that have already been implemented.
  • Version Lag Analysis: Identifies documentation referencing significantly older software versions compared to the current codebase.
  • "Coming Soon" Verification: Checks if promised features are implemented, cancelled, or genuinely still in active progress by analyzing code and commit history.
  • Use Case: Schedule this skill to run monthly to get a report on all stale documentation, ensuring your project's README.md and guides always reflect the current state of the software.
  • Use Case: Automatically update "Last Updated" dates in documentation to match the actual Git commit history, maintaining accuracy without manual effort.

Quick Start

This skill is typically auto-invoked as part of a larger workflow.

To manually trigger a documentation currency report:

/align-project

(Select Phase 3: Documentation currency from the options presented)

Frequently Asked Questions about documentation-currency

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

FAQPage Schema
How do I detect stale documentation in my project?▼

Detect stale documentation by scanning Markdown files and docs/* for outdated status markers, obsolete TODOs, and version references that no longer match your codebase. This skill uses pattern detection and Git history comparison to identify and report currency issues automatically.

Can I automatically flag documentation that references old software versions?▼

Yes. Version lag analysis identifies documentation referencing significantly older software versions compared to your current codebase. The skill compares version references in release notes, READMEs, and API docs against actual Git history to surface mismatches.

How do I verify if 'coming soon' claims in documentation are still accurate?▼

Verify 'coming soon' claims by analyzing code and commit history to determine whether promised features are implemented, cancelled, or genuinely still in active progress. The skill flags outdated promises that erode user trust.

What's the best way to keep README and API documentation current without manual updates?▼

Schedule this skill to run monthly for automated currency reports on all documentation. It flags stale content and can automatically update 'Last Updated' dates to match Git commit history, reducing manual maintenance effort.

Does this work with version control systems to validate documentation accuracy?▼

Yes. The skill implements Git history comparisons to validate documentation accuracy against actual project state. It detects when status markers and version references diverge from what your repository's Git history confirms as current.

Can I use this skill to audit Markdown files across my entire repository?▼

Yes. The skill applies to all Markdown and docs/* files across your repository, implementing semantic checks and pattern detection to audit status markers, TODOs, and version references at scale without manual review.

Related Skills

Explore More Software Engineering Skills→
DoezerDoezer
538

release-notes

Generate markdown release notes from git commit history.

Community
Intermediate
shren207shren207

checking-freshness

Detect outdated skill documentation by comparing source changes with SKILL.md files.

Community
Basic
shirulotshirulot

changelog-automation

Parse commit history to generate changelogs and release notes.

Community
Advanced
AIBiz-AutomatyzacjeAIBiz-Automatyzacje
70

code-review

Automate React code review with static analysis and pattern detection.

Community
Advanced