agentleFS
Sign inStart free
rmichakrmichak/claude-skills/update-docs/SKILL.md

update-docs

Skill1 starsChanged 9 days agoMITView on GitHub

Update README.md and CLAUDE.md when application functionality changes. Use when the user says "update docs", "update documentation", "/update-docs", or PROACTIVELY after modifying API routes, components, database schema, or adding/removing features. Also use when the user asks to "read the docs", "what does this app do", or needs context about the current project.

87 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use get-pr-reviews, push-everything and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • saffron-healthSkill

    get-pr-reviews

    Get nicely formatted output of the last review comments on a PR. Used internally by other skills.

    Also in 3 projects that use this

  • saffron-healthSkill

    push-everything

    Stage ALL changes in the repository (not just session changes), commit, and push. Use when you need to commit all pending changes.

    Also in 3 projects that use this

  • TheKREATORSSkill

    instinct-export

    Export instincts from project/global scope to a file

    Also in 3 projects that use this

  • TheKREATORSSkill

    instinct-import

    Import instincts from file or URL into project/global scope

    Also in 3 projects that use this

  • NVIDIASkill

    generate-spec

    Produce a feature specification covering API changes, backward compatibility, cross-language impact, performance, and a file-level change plan. Use when designing a new feature, planning a significant change, or the user asks to spec something out.

    Also in 3 projects that use this

  • belokonmSkill

    fullstack-developer

    End-to-end feature expert specializing in frontend-backend integration, system architecture, and complete application development

    Also in 4 projects that use this

  • +1 more from saffron-health
  • +1 more from TheKREATORS

The file

Show its rules and text

We split this skill into the rules it gives an agent

16 rules. 0 are common, 16 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 16

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Features: Add/remove feature descriptions

    line 41
  2. Distinctive:

    Getting Started: Update setup steps if changed

    line 42
  3. Distinctive:

    Usage: Update workflow descriptions

    line 43
  4. Distinctive:

    Keep language accessible to end users.

    line 45
  5. Distinctive:

    Commands: Add new npm scripts

    line 51
  6. Distinctive:

    Architecture > Stack: Update if dependencies change significantly

    line 52
  7. Distinctive:

    Architecture > Key Data Flow: Update if workflow changes

    line 53
  8. Distinctive:

    Key API Routes: Add/remove route descriptions

    line 54
  9. Distinctive:

    Important Patterns: Document new patterns introduced

    line 55
  10. Distinctive:

    Directory Structure: Update if new directories added

    line 56
  11. Distinctive:

    Keep technical and concise.

    line 58
  12. Distinctive:

    Read both files to confirm accuracy

    line 63
  13. Distinctive:

    Ensure no stale information remains

    line 64
  14. Distinctive:

    Check that new features are documented

    line 65
  15. Distinctive:

    When user asks about the app or needs context:

    line 69
  16. Distinctive:

    When requested, read and summarize both README.md and CLAUDE.md completely.

    line 82

“Common” is measured: kept by at least 6 in 10 of the 81 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Update Docs

Maintain documentation accuracy by updating README.md and CLAUDE.md when code changes affect functionality.

When to Trigger

Automatically after changes to:

  • API routes (src/app/api/**/*.ts)
  • Page components (src/app/**/page.tsx)
  • Database schema (scripts/init-db.js)
  • Key library files (src/lib/**/*.ts)
  • Package dependencies (package.json)

On explicit request:

  • "update docs", "update documentation", "sync docs"
  • "read the docs", "what does this app do"

Update Workflow

1. Detect What Changed

Identify the type of change:

Change TypeFiles AffectedDoc Sections to Update
New API routesrc/app/api/**/route.tsCLAUDE.md: Key API Routes
New pagesrc/app/**/page.tsxREADME.md: Features
DB schemascripts/init-db.jsCLAUDE.md: Database Location
New commandpackage.json scriptsCLAUDE.md: Commands
New dependencypackage.jsonCLAUDE.md: Stack

2. Update README.md

README.md is user-facing documentation. Update these sections:

  • Features: Add/remove feature descriptions
  • Getting Started: Update setup steps if changed
  • Usage: Update workflow descriptions

Keep language accessible to end users. Focus on what the app does, not implementation details.

3. Update CLAUDE.md

CLAUDE.md is AI guidance documentation. Update these sections:

  • Commands: Add new npm scripts
  • Architecture > Stack: Update if dependencies change significantly
  • Architecture > Key Data Flow: Update if workflow changes
  • Key API Routes: Add/remove route descriptions
  • Important Patterns: Document new patterns introduced
  • Directory Structure: Update if new directories added

Keep technical and concise. This guides AI assistants working on the code.

4. Verify Updates

After updating documentation:

  1. Read both files to confirm accuracy
  2. Ensure no stale information remains
  3. Check that new features are documented

Reading Documentation

When user asks about the app or needs context:

Quick Summary

Provide: app purpose, tech stack, key commands (npm run dev, npm run build, npm run db:init)

Context-Aware Reading

Based on current work:

  • Working on API? Read CLAUDE.md "Key API Routes" section
  • Working on UI? Read README.md features + CLAUDE.md components
  • Database work? Read CLAUDE.md "Database Location" and schema info
  • New to project? Read both files' overview sections

Full Documentation

When requested, read and summarize both README.md and CLAUDE.md completely.

Documentation Standards

README.md style:

  • User-friendly language
  • Focus on features and usage
  • Include screenshots/examples where helpful

CLAUDE.md style:

  • Technical and concise
  • Code patterns and file paths
  • Architecture decisions

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free