agentleFS
Sign inStart free
maidepsmaideps/ai-harness-framework/skills/update-docs/SKILL.md

update-docs

Skill2 starsChanged 6 days agoMITView on GitHub

Docs-drift pass after code changes — manifest, architecture, and guides updated in the same commit.

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, 5 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    After any code change that touches a documented surface

    line 11
  2. Very specific:

    After layout changes (new/moved/renamed files)

    line 12
  3. Distinctive:

    Before every commit — as a checklist, not an afterthought

    line 13
  4. Distinctive:

    Update each affected surface:

    line 18
  5. Very specific:

    Run npm run check — the lint layer catches placeholder drift and skill format drift.

    line 26
  6. Distinctive:

    Commit docs in the same commit as the code change.

    line 27
  7. Distinctive:

    No stale documentation — the same-commit rule is a harness constraint.

    line 31

“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 same-commit rule, operationalized: no stale documentation.

When to Use

  • After any code change that touches a documented surface
  • After layout changes (new/moved/renamed files)
  • Before every commit — as a checklist, not an afterthought

Workflow

  1. Identify what changed: commands, files, layout, contracts, semantics.
  2. Update each affected surface:
    • docs/ARCHITECTURE.md — layer model, harness boundaries, seam contract changes
    • .harness/manifest.json — any layout change (arch-005 fails on unclassified files)
    • README.md and docs/USAGE.md — command surface or workflow changes
    • docs/STANDARDS.md — standards changes
    • docs/quality-document.md — ratings for modules touched this session
    • skills/ — if the change alters a skill's workflow
  3. Templates and instance copies stay in sync: a docs change that ships must update both templates/docs/* and docs/*.
  4. Run npm run check — the lint layer catches placeholder drift and skill format drift.
  5. Commit docs in the same commit as the code change.

Rules

  • No stale documentation — the same-commit rule is a harness constraint.
  • Docs describe what IS, not what was planned or hoped.
  • A docs-only fix is still a real commit: small, focused, explaining why.

Quick Reference

  • Touched surfaces identified
  • ARCHITECTURE.md and manifest updated for layout changes
  • README/USAGE updated for command changes
  • Templates + instance copies in sync
  • Same commit as the code change

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