The Tao of Documentation
by Engine Yard on Nov 22, 2011
- 2,603 views
Presenter: Danish Khan ...
Presenter: Danish Khan
Presentation from: RubyConf Uruguay
Date: November 12, 2011
Description:
Most developers hate having to write documentation, yet complain about how tools and libraries we use lack documentation. 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, YarDoc, and RDoc. These tools are useful for creating documentation for tools, gems and varies open source projects and each one has it's unique way of making documentation easier for developers. However, how do you manage documentation for a product? At Engine Yard we have our Engine Yard Cloud platform. Good external documentation for our customers is very important to us. We want to make sure they can easily understand how to use our platform and be able to accomplish what they need. However, it has been difficult to get good documentation out quickly.
Check out the audio from Danish's talk here:
http://www.eventials.com/rubyconfuy/recorded/M2UzZTJkMzY2MzdiNTg2NTUxNWM1MzI3NWY1YjRhMzYjIzQ1Ng_3D_3D
Accessibility
Categories
Tags
Upload Details
Uploaded via SlideShare as Adobe PDF
Usage Rights
© All Rights Reserved
Statistics
- Favorites
- 4
- Downloads
- 57
- Comments
- 0
- Embed Views
- Views on SlideShare
- 2,585
- Total Views
- 2,603
Jungpyo Lee