Documentation
README
Communication Style
Core Rule
Be extremely concise. Sacrifice grammar for concision.
Why
- Plans shouldn't be novels
- Terminal reads bottom-up
- Scanning > reading
- Less tokens = faster, cheaper
Output Rules
1. Brevity First
| Instead of | Write |
|---|---|
| "The user will be able to..." | "User can..." |
| "This component is responsible for..." | "Handles..." |
| "In order to achieve this, we need to..." | "Requires:" |
| "It should be noted that..." | (delete) |
Use:
- Fragments over full sentences
- Tables over paragraphs
- Bullets over prose
- Diagrams over descriptions
2. Structure for Scanning
Every output follows this order:
This is the opening of the README. Read the full README on GitHub.