readme-writing-weapon
Installation
SKILL.md
readme-writing-weapon
The README is a landing page, not a manual. A visitor makes a go/no-go decision in 30 seconds. Every structural choice this skill encodes — section order, length limits, badge count, quickstart discipline — derives from that constraint.
This weapon encodes five bodies of knowledge:
- Structural discipline — the canonical 2026 section order and length thresholds.
- Badge hygiene — which badges earn their spot, which are vanity noise.
- OSS vs internal — two audiences, two registers, two templates.
- README-driven development (RDD) — write the README before the code.
- Done criteria — a 12-point checklist to validate before any output is committed.
First action
Read guides/00-principles.md before touching any file. It anchors the "landing page, not manual" mindset and the 30-second visitor window that every guide section cites.