agentleFS
Greg-KleinGreg-Klein/implementation-harness/skills/document-change/SKILL.md

document-change

Skill1 starsChanged 34 days agoMITView on GitHub

Update repository documentation made stale by an authorized code change, covering decisions, contracts, configuration and the behavior actually shipped. Use when a change affects existing documentation or introduces a mechanism that needs a documented home.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. Greg-Klein/implementation-factory★ 1100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository13 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    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:

    Check references and examples against the changed code.

    line 14

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Document a change

Input: actual change, repository documentation and permitted file scope. Output: targeted documentation updates, or a list for the caller when writing is not authorized.

  1. Find the existing home: README, architecture and feature pages, indexes, configuration examples or changelog. Read neighboring documentation before choosing format and depth.
  2. Identify statements the change makes false or incomplete: state ownership, lifecycle, contracts, routes, settings, installation or operation. Update existing pages before creating a new one.
  3. Explain consequential decisions and non-obvious constraints. Describe only what has shipped; distinguish a partial feature from future work. Link to code for implementation details instead of copying code that will drift.
  4. Match the repository's language, structure and level of detail. Write the prose with implementation-factory:unslop. When a new page is necessary, connect it to an existing index. Keep changes within the caller's file ownership; return missing scope to the planner or pilot.
  5. Check references and examples against the changed code. Do not claim commands or examples were executed unless they were. Exclude secrets, runtime ticket content and private session links.

This skill writes documentation files, never comments in the code: the engineering principles forbid them. A reason a reader could get wrong goes in the commit message, the merge request description or the documentation page.

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.

Reviews can't be read right now.

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.