Skip to content

Instantly share code, notes, and snippets.

@ssuravarapu
Created February 1, 2026 17:38
Show Gist options
  • Select an option

  • Save ssuravarapu/72ef65fb68dc07398947e9f3375e5bdc to your computer and use it in GitHub Desktop.

Select an option

Save ssuravarapu/72ef65fb68dc07398947e9f3375e5bdc to your computer and use it in GitHub Desktop.
name docs
description Review and update project documentation to keep it current with code changes
allowed-tools Read, Glob, Grep, Edit

Documentation Maintenance

When invoked, check if documentation needs updating based on recent work.

Steps

  1. Review what changed in the current session or recent commits

  2. Check relevant docs that might need updates:

    • docs/USER_GUIDE.md - if UI changed
    • CLAUDE.md - if patterns/conventions changed
    • DECISIONS.md - if technical decisions were made
    • Feature-specific docs in docs/
  3. Update if needed:

    • Add new features/changes to appropriate docs
    • Keep sections concise and current
    • Don't add redundant information

Arguments

$ARGUMENTS - Optional: Specific doc to focus on (e.g., "user-guide", "decisions")

Behavior

  • If no changes need documenting, say so briefly
  • If updates needed, make them directly
  • Focus on what users/future-Claude need to know
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment