← ClaudeAtlas

cli-forge-readmelisted

Use this skill whenever the user wants to create, improve, audit, or rewrite a README.md file for any project. Triggers include: 'readme', 'README', 'documentation for my project', 'write a readme', 'improve my readme', 'project landing page', or any request to document a codebase, library, CLI tool, infrastructure project, or research repo. Also triggers when the user asks to 'make my project more accessible', 'add a getting started guide', or wants badges, installation instructions, or contributing guidelines. Use this skill even when the user just says 'document this' or 'make this repo presentable'. Do NOT use for API reference docs generation, full documentation sites (mdbook, docusaurus), or man pages.
Destynova2/cli-code-skills · ★ 4 · Data & Documents · score 83
Install: claude install-skill Destynova2/cli-code-skills
> **Optimization:** This skill uses on-demand loading. Heavy content lives in `references/` and is loaded only when needed. > **Language rule:** Skill instructions are written in English. When generating user-facing output, detect the project's primary language (from README, comments, docs, commit messages) and produce the README in that language. If the project is bilingual, ask the user which language to use before proceeding. # README Generator — Production First Generate professional README.md files where **results come first, plumbing comes second**. **Gotchas** — read `../../gotchas.md` before producing output to avoid known mistakes. ## Philosophy A README is a **landing page**, not a technical manual. - 90% of visitors want to know: what, why, how to start - 10% want to contribute or understand internals - Structure for the 90%, don't punish them with the 10% **Tone rule: Friendly on the surface, technical in depth.** - Tier 1–2: plain language, no jargon, a junior dev or a PM can understand - Tier 3: full technical depth, assume the reader codes ## Workflow ### Step 1 — Detect project context Build the shared reconnaissance brief first — read `../../shared/recon.md` (what / who / problem / headline / differentiator / golden-path). The same brief feeds prez and demo, so the README, slides, and live demo tell one story. Then read the project root to auto-detect the type: | Signal | Project Type | |--------|-------------| | `Cargo.toml` | `rust-lib` or `rust