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

1. Documentation
You’re
Wrong It
Doing

2. Documentation
You’re
Wrong It
Doing

3. The Tao
Of
Documentation
danish khan

5. @danishkhan

7. KHAN!!!

10. Become
One
With
Documentation

11. Become
One
With
Documentation

12. daksis

14. “Do the difficult things while they are easy and do the great
things while they are small. A journey of a thousand miles must
begin with a single step.”
Lao Tzu

18. WHY?
adelcambre

19. Enlightenment
tsaleh

20. Pain!
slackX

22. gollum
github/gollum stasis
winton/stasis
nanoc
ddfreyne/nanoc
staticmatic staticmatic/staticmatic middleman
tdreyno/middleman
frank blahed/frank
jekyll
high_voltage mojombo/jekyll
thoughtbot/high_voltage

24. gollum
github/gollum
gollum-site
dreverri/gollum-site
rdiscount
rtomayko/rdiscount

25. engineyard/ey-docs

27. http://www.decisionesinteligentes.com/guides

28. Data

29. 19 contributors

30. 19 contributors

31. GitStats
https://github.com/trybeee/GitStats

35. More page views
26,742 Pageviews (up from 17,050, 56.8%)
More visits
10,306 Visits (up from 5661, 82%)
More visitors
5,479 Visitors (up from 2,286, 140%)

36. The Journey never ends
daksis

38. Release Notes
http://docs.engineyard.com/release_notes.html

40. Fix
Minor
Major
Action Req’d

42. Action Req’d
Look at your documentation

43. https://github.com/lifo/docrails

44. Thank you

45. Questions?
twitter.com/danishkhan
engineyard.com