← ClaudeAtlas

readmelisted

Use when writing, restructuring, auditing, or polishing a repository README — creating one for a new project, rewriting one that has gone stale or bloated, checking whether it tells a newcomer what they actually need, or bringing an inherited repository in line with the house style. Triggers on 写个 readme, 更新一下 readme, readme 太乱了, readme 写得怎么样, 帮我整理 readme, write a readme, polish the readme, the readme is out of date, does this readme make sense. Not for API reference documentation, changelogs, contribution guides, blog posts, or marketing landing pages.
Misoto22/skills · ★ 0 · AI & Automation · score 73
Install: claude install-skill Misoto22/skills
# Readme A README answers three questions for someone who has never seen the repository: what is this, can I run it, and where do I go next. Everything else is a distraction from those three. ## When a request names several repositories Treat every explicitly named repository as its own scope. Record its exact path or URL, README target, available evidence, and verification state before editing. If a name cannot be resolved to one repository, ask; never widen the scope by searching an unspecified parent directory. Inspect, write, and render-check independent repositories concurrently when the host supports concurrent work. Keep their commands, versions, deployment facts, assets, and reader language separate unless the user supplies evidence that a fact is shared. An inaccessible or blocked repository does not delay safe work on another one. Give one combined handoff with a clearly labelled result for each repository: changed files, evidence and rendering checks, then any remaining blocker. A single successful README never stands in for the rest. ## Read the repository before writing a line Never describe a project from its name. Every claim in the output must come from a file you read. | To write | Read | |---|---| | Tech stack, versions | `package.json`, `pyproject.toml`, `Cargo.toml`, lockfile | | Getting started | the task runner (`justfile`, `Makefile`, `package.json` scripts), `.env.example` | | Project structure | the actual tree, two levels deep | | Features |