README Style Guide

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

tools-only Updated 7 repo stars

File contents

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.

tools-only/X-Skills/tree/main/content-creation/039-install_9bc63081 commit 7df7fd7123

Frequently asked questions

npx skillmds@latest add tools-only/readme-style-guide