×
  • Share
  • Email
  • Embed
  • Like
  • Private Content
 

The Tao of Documentation

by on Nov 23, 2011

  • 3,531 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

Statistics

Views

Total Views
3,531
Views on SlideShare
3,512
Embed Views
19

Actions

Likes
4
Downloads
62
Comments
0

4 Embeds 19

http://paper.li 11
http://camila181.blogspot.com 4
http://www.onlydoo.com 3
http://us-w1.rockmelt.com 1

Accessibility

Categories

Upload Details

Uploaded via SlideShare as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
Post Comment
Edit your comment

The Tao of Documentation The Tao of Documentation Presentation Transcript