It's concerning how many internal projects have no docs
It's concerning how many internal projects have no docs. A readme is critical for closed source too.
What's this for?
How does it work?
How do I get started?
Browser/OS support?
Release process?
Starting a new project? Begin with the readme. It's easy to change. 😄
Excellent read on the topic: "Readme Driven Development"
Write your readme before writing a line of code. It's a bit like TDD, but super easy to change. It will force you to think through your design early.
http://tom.preston-werner.com/2010/08/23/readme-driven-development.html