Tao Of Documentation
Most developers hate having to do documentation, yet we complain about how the tools and libraries we use lack documentation. So the question is: how do you get developers to write good documentation without feeling like they’re wasting their time? There are plenty of good documentation tools out there, such as TomDoc, YardDoc, and RDoc — each with its own unique way of making documentation easier for developers, gems, and various open source projects.
How do you manage documentation for a product? At Engine Yard, we had our AppCloud product, and having good external documentation for our customers was very important to us — we wanted to make sure they could easily understand how to use the product and accomplish what they needed. However, it was always difficult to get good documentation out quickly.