← ClaudeAtlas

write-clear-readmelisted

Author, audit, or polish a project README — clarity, structure (Pattern A per-section collapse / Pattern B grouped / Pattern C per-entry), wording concision, anchor integrity. Reads the repo first, proposes diffs, applies on approval.
coroboros/agent-skills · ★ 0 · AI & Automation · score 78
Install: claude install-skill coroboros/agent-skills
<!-- Exception — `disable-model-invocation: true`. READMEs are high-stakes, user-facing artifacts; Claude should never autonomously decide to rewrite one based on a casual keyword. The user must explicitly invoke via `/write-clear-readme`. The `when_to_use` keywords still help the user discover the skill in the `/` menu listing (per `claude-code-skills.md`, skill listing is independent from model auto-invocation). --> # Write Clear README <!-- canonical:writing-rules:start --> ## Important — Writing rules These rules govern every prose artifact this skill emits — READMEs, CHANGELOGs, commit messages, PR bodies, release notes, doc paragraphs, non-trivial comments. Apply them at draft time, verify before output. - Match the surrounding style — punctuation, capitalization, backtick conventions, em-dash vs parens, bullet style. - Every sentence changes the reader's understanding. Cut it otherwise. - Front-load the verb — "Creates", not "This helps you create". - Concrete over abstract. Lists for ≥3 enumerable items. - Assert positively. Reserve negation for real constraints (`NEVER commit secrets`). - No marketing words: powerful, robust, seamlessly, leverage, unlock, comprehensive, delightful. - No AI tells: delve, tapestry, intricate, pivotal, testament, underscore, crucial, garner, showcase, additionally, moreover, furthermore, indeed. - After drafting English prose, invoke `/humanize-en` if installed. <!-- canonical:writing-rules:end --> Author, audit, or polish a README