agentleFS
jcarlosrodiciojcarlosrodicio/norma/skills/update-docs/SKILL.md

update-docs

Skill1 starsChanged 2 months agoMITView on GitHub

Use as the last step of any change that altered behaviour, contracts, schema or architecture, before committing - updates the technical documentation the project treats as its source of truth so the next session starts from accurate context.

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

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

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 7

    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:

    Read AGENTS.md - it is the index that says which documents exist and what each one owns.

    line 16
  2. Distinctive:

    Update those documents. Match the existing structure and heading style.

    line 30
  3. Distinctive:

    Add nothing that duplicates the code.

    line 32
  4. Distinctive:

    If the change made an existing statement false, fix the statement.

    line 34
  5. Distinctive:

    Do not create new documents when an existing one owns the topic.

    line 39
  6. Distinctive:

    Do not write a changelog entry of what you just did unless the project keeps one.

    line 40
  7. Distinctive:

    Do not leave a documentation TODO instead of the update.

    line 41

“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

The repository is the source of truth for the harness. Documentation that lags the code silently poisons every future session, so this step is mandatory, not optional, and it runs before the commit.

Process

  1. Read AGENTS.md - it is the index that says which documents exist and what each one owns.
  2. From the diff, decide which of them the change invalidated. Typical triggers:
    • new or changed API contract -> the API spec document;
    • schema, migration or model change -> the data-model document;
    • new dependency direction, boundary or composition change -> the architecture document and, if a rule was bent, an ADR;
    • new command, script or environment variable -> the development/setup guide;
    • behaviour a future reader would find surprising -> the relevant spec or ADR;
    • a roadmap phase or milestone this change completes -> the roadmap entry, its status column, and any phase document that still describes the work as pending. This is the update that gets forgotten, because it is the only one the diff cannot lead you to: nothing in the code mentions the roadmap. A phase left open after it shipped is how the next session builds it twice.
  3. Update those documents. Match the existing structure and heading style; do not restructure a document as a side effect.
  4. Add nothing that duplicates the code. Documentation carries intent, contracts and decisions - not a paraphrase of the implementation.
  5. If the change made an existing statement false, fix the statement. Stale text is worse than missing text.

Do not

  • Do not create new documents when an existing one owns the topic.
  • Do not write a changelog entry of what you just did unless the project keeps one.
  • Do not leave a documentation TODO instead of the update.

Report

List the documents updated and, in one line each, what changed. If nothing needed updating, say which documents you checked and why they were unaffected - that is a valid outcome, an unchecked assumption is not.

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.