docs
Skill262 starsChanged 2 months agoApache-2.0View on GitHub
Update existing project documentation to reflect the current state of the branch
We split this skill into the rules it gives an agent
16 rules. 0 are common, 15 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 128 edited versions we read keep these.
15
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 6
Update existing project documentation to reflect the current state of the branch.
- Distinctive: line 8
Read AGENTS.md first. It is the canonical project guide for this repository.
- Distinctive: line 12
Run git diff main...HEAD --stat and git log main..HEAD --oneline to understand what changed on this branch
- Distinctive: line 13
Read the changed files to understand what was added, removed, or modified
- Very specific: line 14
Read the current documentation files: README.md, docs/Architecture.md, AGENTS.md, CLAUDE.md, .github/copilot-instructions.md
- Distinctive: line 28
Minimal changes only: Do not rewrite sections that are already accurate.
- Distinctive: line 30
Keep it concise: Prefer inline descriptions over new subsections.
- Distinctive: line 31
Match existing style: Follow the formatting, tone, and structure already in each file.
- Distinctive: line 32
One edit per concern: If a section needs updating, make one focused edit rather than rewriting the whole section.
- Distinctive: line 35
After editing, report what was updated:
- Distinctive: line 38
If no docs needed updating, say "Documentation is up to date" and stop
- Distinctive: line 42
Create new documentation files
- Distinctive: line 43
Add sections or headings that don't already exist
- Distinctive: line 45
Document internal implementation details
- Distinctive: line 46
Add emojis, badges, or decorative elements
- Distinctive: line 47
Update docs for changes that don't affect user-facing behavior
“Common” is measured: kept by at least 6 in 10 of the 128 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.
Files
Update existing project documentation to reflect the current state of the branch.
Read AGENTS.md first. It is the canonical project guide for this repository.
Steps:
- Run
git diff main...HEAD --statandgit log main..HEAD --onelineto understand what changed on this branch - Read the changed files to understand what was added, removed, or modified
- Read the current documentation files:
README.md,docs/Architecture.md,AGENTS.md,CLAUDE.md,.github/copilot-instructions.md - Identify documentation that is now outdated or missing based on the branch changes
- Apply minimal, targeted edits to bring docs in line with the code
What to update:
- Architecture.md — new push actions, configuration parameters, plugins, build steps, authentiction methods
- README.md — project description, features list, usage examples
- AGENTS.md — canonical project architecture, invariants, testing commands, and AI-agent workflow guidance
- CLAUDE.md — Claude-specific entry point that should remain aligned with
AGENTS.md - .github/copilot-instructions.md — short Copilot-compatible summary of the highest-priority repo rules
Principles:
- Minimal changes only. Do not rewrite sections that are already accurate. Edit the smallest possible region.
- Capture important information. New commands, config keys, classes, architecture changes, and breaking changes must be documented.
- Keep it concise. Prefer inline descriptions over new subsections. Use tables and bullet points. Avoid verbose prose.
- Match existing style. Follow the formatting, tone, and structure already in each file. Do not add headings, sections, or patterns that don't already exist.
- One edit per concern. If a section needs updating, make one focused edit rather than rewriting the whole section.
- Skip trivial changes. Internal refactors, renames, or implementation details that don't affect the public interface do not need doc updates.
After editing, report what was updated:
- List each file edited and a one-line description of the change
- If no docs needed updating, say "Documentation is up to date" and stop
Do NOT:
- Create new documentation files
- Add sections or headings that don't already exist
- Rewrite large blocks of text when a small edit suffices
- Document internal implementation details
- Add emojis, badges, or decorative elements
- Update docs for changes that don't affect user-facing behavior
Other versions160 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 160
- remotion-dev/remotion★ 70ksame name
- jlowin/fastmcp★ 28ksame name
- PrefectHQ/fastmcp★ 28ksame name
- ccusage/ccusage★ 19ksame name
- ryoppippi/ccusage★ 19ksame name
- micronaut-projects/micronaut-core★ 6.4ksame name
- latitude-dev/latitude-llm★ 4.7ksame name
- samuelgursky/davinci-resolve-mcp★ 3.9ksame name
- TanStack/ai★ 3.3ksame name
- patrykandpatrick/vico★ 3.2ksame name
150 more not listed
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.
Used alongsideProjects with it also use import-memory, build-fix and 9 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.
amirbironSkillimport-memory
Import a memory export from another AI assistant into Claude's memory — conversationally, additively, and with the content treated as data.
Also in 3 projects that use this
diego-tobalinaSkillbuild-fix
Fix build and compilation errors systematically. Run when build fails.
Also in 3 projects that use this
MicrosoftSkillperf
Speed and memory performance rules for Rust crates, the Node addon, webui-framework, and webui-router.
Also in 4 projects that use this
vbrevikSkillwork
Use when the user says 'plan', 'todo', 'copy plan', 'append plan', 'resume plan', 'priorities', or 'what's next'.
Also in 7 projects that use this
JkudjoSkillincident
Production incident response — structured triage, hypothesis tree, safe remediation, incident record
Also in 4 projects that use this
mbwsimsSkillimpact
This skill should be used when the user asks to "check the impact", "what will break if I change this", "blast radius", "impact analysis", "what depends on this", "who imports this", "is it safe to change this", mentions "/impact", or wants to understand the consequences of modifying a specific file or function before making changes.
Also in 3 projects that use this
In this repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- address-reviewSkill
- commitSkill
- implementSkill
- issueSkill
- lintSkill
- sink-paritySkill
- summarySkill
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
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.

