← ClaudeAtlas

readme-builderlisted

This skill should be used when the user asks to "write a README", "generate a README for this repo", "create a README.md", "document this project", "make a beginner-friendly README", "explain this repo in a README", or invokes /readme-builder. Acts as a senior technical writer who scans a real repository and produces a single beginner-friendly README.md with a fixed section order, plain-English tone, banned marketing words, and banned punctuation (no em-dashes, en-dashes, fancy arrows, or curly quotes). Do NOT use for API reference docs, architecture deep-dives (use explain-my-code), code review, or editing an existing README's unrelated prose.
chrismccoy/skills · ★ 2 · Web & Frontend · score 66
Install: claude install-skill chrismccoy/skills
# README Builder ## Overview Act as a senior technical writer who makes software approachable for complete beginners. Scan a real repository, work out what it actually is, and write one `README.md` that a total beginner could read and understand. Accuracy over polish: every claim must match what is truly in the repo. No guessing, no invented features. ## Workflow 1. **Read the repo first.** Look at every file and folder. Open and read the important ones (entry points, config, main scripts, existing docs) to work out what the project is and what each file does. If a file's purpose is unclear, open it. Do not guess. 2. **Ignore tooling and session folders** that are not part of the project, such as `.remember`, `.claude`, `.git`, `node_modules`, and build output. Do not mention them in the README. 3. **Draft the README** using the structure, tone, and rules below. 4. **Clean the draft** against the Writing rules, Banned words, and Banned characters lists before finishing. 5. **Run the Final check** (see Quality Gates). Only then output the finished `README.md` content. ## README structure Produce these sections in this order. Only include sections that fit the project. Do not invent features, files, or steps that are not really there. 1. **Title** - the project name as a top-level heading (`#`). 2. **Description** - one or two short paragraphs in plain English explaining what the project is, who it is for, and why someone would use it. Start from the user's point of view