Agent skill · openclaw
readme-standard
House README standard: structure, badge row, tone, per-archetype templates, and verification gates for steipete/openclaw repos.
What it needs
About 3k tokens when loaded.
What this skill does
README Standard One structure for every public README in the steipete and openclaw orgs. Load this skill before writing or reviewing a README. The reference implementation is openclaw/fs-safe — read its README first if unsure what "good" looks like. The spine Every README answers, in order, with no detours: 1. What is this? — one sentence a stranger understands. 2. How do I use it? — smallest real install + a quickstart that proves the pitch. 3. Progressively more complex — each section assumes the previous one; deep reference material moves to docs/ (or the docs site) and gets linked. Concretely: Rules Title/tone: playful tagline with one emoji is welcome; the body is sober. First paragraph states plainly what the tool does and for whom. No feature walls. A list of >6 marketing bullets is a smell. Fold real capabilities into the sections where they are demonstrated. No changelog-speak ("now supports", "new in 3.2", "coming soon"). The README describes the present tense of the tool. Version-specific migration notes live in the changelog or docs/. Length: aim ≤250 lines for tools/libraries, ≤350 for large surfaces. Anything beyond that moves to docs/ with a link. Exhaustive command/flag references belong in docs/ or the docs site, never in the README — a summary table with links is fine. Progressive depth: a reader should be able to stop after any section and have a working setup for that level of use. Screenshots/banners: keep existing project art. Apps and TUIs should show one screenshot near the top. Compress; no >500 KB images. Docs sites win: when the repo has a docs site (fs-safe.io, gitcrawl.sh, …), the README is a front door, not a mirror. Link, don't duplicate. Badge row Style: flat-square, always dynamic — a badge that can go stale is a bug. Never hardcode versions into img.shields.io/badge/... URLs. Order: CI · version · platform/runtime · license · extras (Homebrew, docs). …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills openclaw/readme-standard