agentleFS
TidalPaladinTidalPaladin/skills/doc-update/SKILL.md

doc-update

Skill1 starsChanged 23 days agoApache-2.0View on GitHub

Update or audit project documentation against code, configuration, and working changes.

8 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 3

    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:

    Use the user's targets. Without explicit targets, inspect root guidance and README files, then follow documentation affected by the current …

    line 8
  2. Distinctive:

    Do not expand a narrow correction into a full documentation audit.

    line 10
  3. Distinctive:

    Verify material claims against code, configuration, generated help, or policy.

    line 12

“Common” is measured: kept by at least 6 in 10 of the 8 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

Doc Update

Use the user's targets. Without explicit targets, inspect root guidance and README files, then follow documentation affected by the current changes. Do not expand a narrow correction into a full documentation audit.

Verify material claims against code, configuration, generated help, or policy. Account for staged and unstaged changes. Keep commands, paths, and terminology consistent. Put detailed guidance in one canonical location and link to it where readers need it.

For skill documentation, make triggers specific and load references only for the relevant task. Preserve concrete safeguards and remove generic instructions that do not change decisions.

Validate changed links, commands, and instructions with checks suited to the change. Run commands only when their effects are authorized. Explain any unverified claim or blocked check instead of presenting it as confirmed.

For a broad audit, use the audit checklist. Finish when the requested documents reflect repository truth and their affected references agree. Report changes, validation, and unresolved mismatches.

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.