readme-maintainer
Skill9 starsChanged 3 days agoMITView on GitHub
Maintain, update, and rewrite concise, publication-ready repository README files grounded in codebase facts. Use when updating README.md, refreshing installation and usage guides, verifying CLI commands, or aligning bilingual documentation.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- Heathins98/Claude_Skillstheir own version, first seen Oct 25, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- Heathins98/Claude_Skills★ 0same name
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 repository17 other files it gives its agents.
- brief-outputSkill
- google-go-styleSkill
- insight-collectorSkill
- insights-reportSkill
- json-canvasSkill
- md2wechatSkill
- note-creatorSkill
- obsidian-basesSkill
- obsidian-markdownSkill
- peleSkill
- portpilot-assistantSkill
- publication-ready-docs-jevSkill
- publication-ready-docsSkill
- sync-to-githubSkill
- tech-articleSkill
- wechat2mdSkill
- wechat-archiverSkill
The file
We split this skill into the rules it gives an agent
11 rules. About 0 are common, 11 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈11
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
- Distinctive: line 17
Verify claims against code: Verify installation steps, prerequisites, environment variables, and CLI commands against actual repository …
- Distinctive: line 25
Delete meta-discourse, author reflections, and review commentary.
- Distinctive: line 28
Keep only sections the reader needs.
- Distinctive: line 31
If bilingual READMEs exist, ensure semantic parity across sections.
- Distinctive: line 36
Verify & report: Test links, verify command syntax, and report material changes outside the README.
- Distinctive: line 40
Grounding: Never invent compatibility guarantees, benchmarks, test coverage stats, or feature lists.
- Distinctive: line 42
Brevity with completeness: Delete conversational filler, but keep essential setup commands, parameter definitions, and failure recovery …
- Distinctive: line 46
Before completing the task, verify:
- Distinctive: line 48
All installation and run commands match repository build tools.
- Distinctive: line 50
All internal links and relative file paths resolve correctly.
- Distinctive: line 51
If bilingual, both language sections cover identical concepts without drift.
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 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.
Files
README Maintainer Skill
Generate and maintain clear, verified README files directly from repository source code, build manifests, and runtime configuration. Standard Markdown is assumed knowledge.
Workflow
- Locate README and files: Identify repository root and existing
README.md. Read the current content. - Collect repository facts: Inspect
package.json,Cargo.toml,pyproject.toml, CLI help outputs, and configuration files. For repository-wide updates, run:bash "<skill-dir>/scripts/collect_repo_facts.sh" "<repo-path>" - Verify claims against code: Verify installation steps, prerequisites, environment variables, and CLI commands against actual repository source code. Delete stale claims and unverified statements.
- Structure the document:
- Project Overview: One concise sentence describing what the project does.
- Prerequisites & Installation: Exact runtime versions, package managers, and setup commands.
- Quick Start / Basic Usage: Minimal runnable command or code example with realistic input and output.
- Configuration / Key Options: Essential configuration table or common operations.
- Documentation Links: Link detailed architectural guides, API references, and development procedures to existing files instead of duplicating them.
- Apply publication pass:
- Delete meta-discourse, author reflections, and review commentary.
- State product features and constraints directly in active voice.
- Define each technical fact in one authoritative place.
- Keep only sections the reader needs. A README is an entry point, not an exhaustive encyclopedia.
- Align bilingual documentation (if applicable):
- Match the existing language convention.
- If bilingual READMEs exist, ensure semantic parity across sections. Run:
The script accepts one file withbash "<skill-dir>/scripts/check_bilingual_readme.sh" README.md## English/## 简体中文sections, orREADME.mdplus a companionREADME.<lang>.md; either file works as the argument. It compares heading counts, so keep the section structure identical across languages. A single-language README exits 0.
- Verify & report: Test links, verify command syntax, and report material changes outside the README.
Guidelines
- Grounding: Never invent compatibility guarantees, benchmarks, test coverage stats, or feature lists.
- Single source of truth: Link to specialized documentation (architecture, full API, contributing guides) rather than duplicating large sections.
- Brevity with completeness: Delete conversational filler, but keep essential setup commands, parameter definitions, and failure recovery notes.
Verification Checklist
Before completing the task, verify:
- All installation and run commands match repository build tools.
- Code examples and CLI flags reflect current implementations.
- All internal links and relative file paths resolve correctly.
- If bilingual, both language sections cover identical concepts without drift.
- Output contains no internal editing chatter or temporary task notes.
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.

