4 ms·
Here’s another fancy idea: Write that README before you write the code. I find this idea to be very effective, as long as the scope can be kept to a minimum (t
by JoshMcguigan 7y ago
Here’s another fancy idea: Write that README before you write the code.
I find this idea to be very effective, as long as the scope can be kept to a minimum (think MVP). I've seen it work not only for CLI apps, but also for simple HTTP API servers.
- antoncohen 7y agoReadme Driven Development, a term I first saw used by Tom Preston-Werner (GitHub founder): https://tom.preston-werner.com/2010/08/23/readme-driven-development.html https://tom.preston-werner.com/2010/08/23/readme-driven-deve... I find it to be a great method of development. The core use case (what the project is and why it exists), and the public interface are so important, and often overlooked when people start a project by writing the code first. I tend to write the README in my head naturally, before I start a project, so writing it down makes sense. I also like to write the developer guide part of the README at the beginning (how to setup a development environment), so I ensure the project is easy to contribute to.
- JoshTriplett 7y agoIf you're working on a command line application, I would also suggest writing the manual page before you start writing the code. You can always change it later, but knowing the surface area of the tool, such as the subcommands and arguments, gives you a good idea of what you're looking to implement.