update-docs

Update project documentation to reflect the current codebase state.

5|3|Updated Oct 23, 2025
One-click install
npx skills add https://github.com/Cygnusfear/claude-stuff --skill update-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/Cygnusfear/claude-stuff/tree/main/skills/update-docs
Command: npx skills add https://github.com/Cygnusfear/claude-stuff --skill update-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Outdated or inaccurate documentation leads to confusion, wasted time, and errors for developers and stakeholders. This skill automates the systematic review and update of all project documentation, ensuring it always reflects the current codebase state.

Core Features & Use Cases

  • Comprehensive Document Review: Systematically audits .plans, CLAUDE.md, docs, and .tasks files for accuracy and completeness.
  • Git-Based Change Analysis: Identifies code changes since the last documentation update to pinpoint areas needing attention.
  • Plan Status Tracking: Verifies implementation progress against plans, marking items as ✅ Done, 📋 Todo, or ⚠️ Obsolete.
  • Use Case: After a major refactor or feature release, use this skill to automatically audit all related documentation, ensuring every change is reflected and all plans are correctly marked as complete or obsolete.

Quick Start

Find all documentation files

find . -name ".md" -not -path "/node_modules/*"

Check when docs were last modified

git log --follow --pretty=format:"%ad %s" --date=short -- .plans/

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep documentation in sync with code changes?

Documentation drift occurs when code changes aren't reflected in docs. This skill audits `.plans`, `CLAUDE.md`, architecture docs, and `.tasks` files against your current codebase, identifying what's outdated and marking plan items as Done, Todo, or Obsolete to ensure accuracy.

Can I automate documentation updates after a major refactor?

Yes. This skill systematically reviews all project documentation files, analyzes git changes since the last update, and automatically flags sections requiring refresh—ideal after refactors or feature releases to audit related docs end-to-end.

What documentation files does this skill check?

The skill scans `.plans`, `CLAUDE.md`, `docs`, and `.tasks` files. It uses git history to identify which docs need attention based on recent code changes, then validates plan status tracking against the current implementation state.

How do I verify documentation accuracy against my codebase?

Before updating documentation, the skill requires mandatory Oracle consultation to preserve critical knowledge, then validates all changes against your current codebase state using git-based change analysis to ensure updates reflect reality.

What's the best way to audit docs for a large project?

This skill performs comprehensive document review by systematically checking all `.md`, `.plans`, and `.tasks` files, then cross-referencing git commit history to identify gaps—providing structured output marking each item's status and relevance.

Do I need git history to update documentation?

Yes. The skill relies on git logs to detect code changes since the last documentation update, pinpointing which docs are affected. This enables targeted updates rather than blind full rewrites.