update-docs
Skill0 starsChanged 6 months agoMITView on GitHub
Update all project documentation, repository metadata, and progress tracking when the codebase has significantly changed. Handles README (EN/CN), CLAUDE.md, CHANGELOG, pyproject.toml, GitHub About/description/topics, and release notes. CRITICAL: bilingual docs are written independently, NOT translated.
90 other projects use a version of this.
Adopted by
Most recently taken up by
- aws-samples/sample-apex-skillstheir own version, first seen Nov 15, 2026
- charlesmsiegel/coding-skillstheir own version, first seen Nov 15, 2026
- alexj11324/Mikkatheir own version, first seen Nov 15, 2026
- iuliandita/skillstheir own version, first seen Nov 15, 2026
- caipe-io/ai-platform-engineeringtheir own version, first seen Nov 12, 2026
- rmichak/claude-skillstheir own version, first seen Nov 8, 2026
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-healthSkillget-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-healthSkillpush-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
TheKREATORSSkillinstinct-export
Export instincts from project/global scope to a file
Also in 3 projects that use this
TheKREATORSSkillinstinct-import
Import instincts from file or URL into project/global scope
Also in 3 projects that use this
NVIDIASkillgenerate-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
belokonmSkillfullstack-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
Other versions90 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 90
- vercel/next.js★ 144ksame name
- pipecat-ai/pipecat★ 17ksame name
- anyproto/anytype-ts★ 9.1ksame name
- vladmandic/sdnext★ 7.4ksame name
- ArcReel/ArcReel★ 6.6ksame name
- dotnet/sdk★ 3.2ksame name
- huggingface/OpenEnv★ 2.9ksame name
- meta-pytorch/OpenEnv★ 2.8ksame name
- man-group/ArcticDB★ 2.6ksame name
- fabro-sh/fabro★ 1.8ksame name
80 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.
In this repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- push-docs-to-feishuSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
13 rules. 0 are common, 11 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 84 edited versions we read keep these.
11
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
- Distinctive: line 26
When triggered, follow this workflow.
- Distinctive: line 30
Read the current state of all docs that may need updating:
- Very specific: line 36
Check current test count: pytest tests/ -q
- Very specific: line 37
Check current GitHub repo state: gh repo view --json description,homepageUrl,topics
- Distinctive: line 80
Avoid: 进行/予以/有着/具有 — just say the verb directly
- Distinctive: line 98
Update GitHub repo with:
- Distinctive: line 109
Read both READMEs aloud in your head — does each sound natural in its language?
- Distinctive: line 120
Don't just copy English README into Chinese and tweak wording — rewrite from scratch
- Distinctive: line 121
Don't use 进行 + verb (e.g., 进行操作 → just use the verb)
- Distinctive: line 122
Don't leave stale test counts in badges or body text
- Distinctive: line 123
Don't forget GitHub About — it's separate from README
- Distinctive: line 124
Don't forget to update CLAUDE.md architecture table when modules are added/removed
- Distinctive: line 125
Don't use machine-translation filler words like 此外、与此同时、值得注意的是
“Common” is measured: kept by at least 6 in 10 of the 84 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 Project Documentation Skill
When triggered, follow this workflow. Never skip steps.
Phase 1: Assess Current State
- Read the current state of all docs that may need updating:
README.md— English readmeREADME.zh-CN.md— Chinese readmeCLAUDE.md— project instructions for ClaudeCHANGELOG.md— release historypyproject.toml— version + description
- Check current test count:
pytest tests/ -q - Check current GitHub repo state:
gh repo view --json description,homepageUrl,topics - Review recent commits since last release to understand what changed.
Phase 2: Plan Content (Critical Step)
Before writing a single word, list what needs to change in each doc:
| Doc | What changed | Action |
| README.md | ... | add / rewrite / remove |
| README.zh-CN.md | ... | add / rewrite / remove |
| CLAUDE.md | ... | update table / test count |
| CHANGELOG.md | ... | add new version entry |
| pyproject.toml | ... | bump version / update description |
| GitHub About | ... | update description + topics |
Phase 3: Write (Bilingual Rule — Most Important)
The Golden Rule
English and Chinese READMEs are written INDEPENDENTLY. Never translate.
Translation produces unnatural Chinese that reads like machine output. Signs of bad translation:
- English word order forced into Chinese sentences
- Overly long sentences with too many clauses
- Stiff academic vocabulary where colloquial would be natural
- Directly translated metaphors that don't work in Chinese
How to write each version
English (README.md):
- Direct, developer-oriented
- Explain the "why" explicitly
- Use concrete examples
- Active voice, present tense
- Short paragraphs, clear headings
Chinese (README.zh-CN.md):
- Natural Chinese engineering prose — write like a Chinese developer would
- Shorter sentences. Chinese reads faster. Be concise.
- The "why" is often implied through contrast, not spelled out
- Technical terms: use standard Chinese translations where they exist (不要中英混杂), but keep code identifiers in English
- Bullet points should be terse — one clause each
- Avoid: 进行/予以/有着/具有 — just say the verb directly
Content parity, not translation parity
Both READMEs should cover the same topics, but the structure, emphasis, and phrasing differ:
- English might spend 3 sentences explaining a concept; Chinese might nail it in 8 characters
- Chinese might use a concrete analogy that resonates with Chinese developers; English might use a different one
- The order of sections may differ if one language flows better that way
Phase 4: Update All Artifacts
- README.md — write naturally in English
- README.zh-CN.md — write naturally in Chinese, independently
- CLAUDE.md — update architecture table, test count, any stale references
- CHANGELOG.md — add new version entry with bullet-point summary
- pyproject.toml — bump version if releasing, update description
- GitHub repo — update About description, homepage URL, topics
Update GitHub repo with:
gh repo edit --description "..." --homepage "..."
gh repo edit --add-topic "..." # repeat for each topicPhase 5: Verify
ruff check . --fix --unsafe-fixes— lint cleanpytest tests/ -q— all tests passgit diff --stat— review what changed- Read both READMEs aloud in your head — does each sound natural in its language?
Release Flow (if version bump needed)
python scripts/bump_version.py patch|minor|major
# Then follow standard-dev-workflow for the release PR.Common Mistakes to Avoid
- Don't just copy English README into Chinese and tweak wording — rewrite from scratch
- Don't use 进行 + verb (e.g., 进行操作 → just use the verb)
- Don't leave stale test counts in badges or body text
- Don't forget GitHub About — it's separate from README
- Don't forget to update
CLAUDE.mdarchitecture table when modules are added/removed - Don't use machine-translation filler words like 此外、与此同时、值得注意的是
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.

