readme-editorlisted

Create or edit a project's landing documentation set — README.md, AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, and llms.txt — by first deciding which artifacts the repo actually needs, then grilling the user one question at a time with recommended defaults, building a compact README map, using official hyperlinks for named tools and technologies, and only then writing. Inspects the repo before asking anything discoverable. Use when the user wants to create, write, edit, rewrite, audit, polish, or "fix up" a README, AGENTS.md, CLAUDE.md, Copilot instructions, llms.txt, or any project landing/onboarding docs.
YosefHayim/dufflebag · ★ 2 · AI & Automation · score 68

Install: claude install-skill YosefHayim/dufflebag

# README Editor A good README is not just polished Markdown. Decide **what each artifact owns** and **which artifacts this repo actually needs** before writing. ## Artifact split | File | Audience | Owns | |------|----------|------| | `README.md` | Humans + builders evaluating or running the project | What it is, who it's for, 5-minute success, usage, scope, official links to tools, and links to deeper docs | | `AGENTS.md` | Coding agents editing the repo | Validation commands, module ownership, repo conventions, what not to assume | | `CLAUDE.md` | Claude Code specifically | Claude-only memory; usually `@import` AGENTS.md plus Claude-specific notes | | `.github/copilot-instructions.md` | GitHub Copilot | Copilot-only conventions | | `llms.txt` | Public AI doc indexers | Curated public docs index; only for projects with substantial public docs | **Default recommendation:** `README.md` + `AGENTS.md`. Single-file `README.md` only for tiny demos with no agents working on them. ## Process 1. **Inspect the repo** before asking anything discoverable. 2. **Capture official links** for public tools, runtimes, frameworks, languages, agents, and package managers named in the README. 3. **Choose the README style** from repo evidence. Use [references/readme-styles.md](references/readme-styles.md) when the project is UI, CLI, SaaS/product, frontend app/tooling, backend/API, library, or docs-heavy. 4. **Grill the user**, one question at a time, each with a recommended answer and a on