Documentation
README
Minimum Viable Implementation Check
Answer every question before writing any code. If the simple version is sufficient, build that. Document why only if you choose a heavier approach.
Required Questions
1. What are you building? One sentence. If you cannot describe it in one sentence, the scope is not defined yet.
2. What is the simplest possible implementation? Usually: a shell script, a single file, a few commands piped together, a cron entry, a git hook. Describe it. Estimate the line count.
3. Why is the simple version insufficient? State a concrete reason. Not "it won't scale" but "it cannot handle binary data" or "it requires a persistent HTTP connection." If you cannot state a concrete reason, build the simple version.
This is the opening of the README. Read the full README on GitHub.