How to write good documentation
- Why is this project necessary
- What does the project do
- How does it accomplish its task
- A summary of the project in 1-2 sentences
- History: why we built this and didn't just use existing tools
- What we've built, including what it does and how it compares to other tools
- How to install and use it
- If possible: Include images and animations showing the tool in action, and explaining its internals sufficiently
- https://news.ycombinator.com/item?id=34303497 CDC File Transfer (github.com/google)
- https://news.ycombinator.com/item?id=34305424 on: CDC File Transfer. "I'm really impressed with the readme file in this repository. Its a master class in effective documentation."