# README Style Guide

> For general writing advice — clear prose, Strunk's rules, and AI patterns to avoid — use the writing-clearly-and-concisely skill.

- Skill: `tools-only/readme-style-guide` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add tools-only/readme-style-guide`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tools-only/readme-style-guide/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tools-only (https://skillmd.com/u/tools-only)
- Updated: 2026-09-29
- Page: https://skillmd.com/skills/tools-only/readme-style-guide

---

# README Style Guide

## Common Mistakes

- **No install steps** - Never assume setup is obvious
- **No examples** - Show, don't just tell
- **Wall of text** - Use headers, tables, lists
- **Stale content** - Add "last reviewed" date
- **Generic tone** - Write for YOUR audience

## Prose Quality

For general writing advice — clear prose, Strunk's rules, and AI patterns to avoid — use the `writing-clearly-and-concisely` skill.