agentleFS
Sign inStart free
kellykampenkellykampen/agent-skills/skills/engineering/update-docs/SKILL.md

update-docs

Skill2 starsChanged 11 days agoMITView on GitHub

Analyze changes since the last git commit and update README.md, docs in /docs/, and CLAUDE.md/AGENTS.md to reflect new features, config, commands, and architectural changes. Use when the user asks to "update the docs", "sync the README", "document what changed", or runs /update-docs. No arguments — it detects changes automatically.

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

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 4

    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:

    Keep docs synchronized with the code by analyzing changes since the last commit and updating the relevant documentation.

    line 14
  2. Distinctive:

    Only document what actually changed — don't rewrite untouched sections.

    line 31
  3. Distinctive:

    Prefer editing existing sections over adding new top-level ones.

    line 32
  4. Distinctive:

    If nothing meaningful changed for docs, say so rather than inventing updates.

    line 34

“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 Documentation

Keep docs synchronized with the code by analyzing changes since the last commit and updating the relevant documentation.

Process

  1. See what changed
    • git diff HEAD — current uncommitted changes.
    • git log --oneline -10 — recent commits for context.
  2. Categorize the changes: new features, bug fixes/refactors, UI/UX, config/env, schema/API.
  3. Read the existing docs first (README.md, docs/**, CLAUDE.md/AGENTS.md) to match their structure and voice before editing — don't impose a new format.
  4. Make targeted updates:
    • README.md — new features (features section), new env vars (setup), new commands/scripts.
    • docs/ — feature docs for new capabilities, technical docs for architectural changes, API reference for new endpoints/functions, setup guides for new requirements.
    • CLAUDE.md / AGENTS.md — new patterns or development practices worth codifying.
  5. Summarize what you updated.

Principles

  • Only document what actually changed — don't rewrite untouched sections.
  • Prefer editing existing sections over adding new top-level ones.
  • Match the project's existing tone, heading style, and formatting.
  • If nothing meaningful changed for docs, say so rather than inventing updates.

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