For small agile teams (expressive and specific labels, mostly-linear git history)
| README.md | Adhere closer to five Ws | |
Project name
Your readme is the project's face. Make sure entities understand:
- motivation: what problem it solves
- documentation: where to learn using it
- ideally, list examples here (screenshots, code snippets, the works)
- target group: whom it is made for (CLI for admins? App for everyday smartphones?)
- expectations: where it is headed to (status, governance, funding)
similar to the Five Ws.
Keep it concise, don't AI-gen it (you run at danger of omitting the important points). Keep in mind: You're not writing this just for your target group, but for everyone curious stumbling across this (including funders).