Writing Effective Documentation
Writing Effective Documentation
By Doug Bell (preaction) from Chicago.pm
Date: Tuesday, 21 June 2016 09:00
Duration: 20 minutes
Target audience: Any
Language: English
Tags: documentation
You can find more information on the speaker's site:
We all know how important documentation is, but it is still the largest problem with most projects I join: Incomplete, out of date, hard to find documentation.
Good documentation is the developer's greatest weapon in the everlasting battle against technical debt. How many parts of your code are overlooked because "I don't know why this is here and I don't want to break anything?"
The talk will cover how to make sure that your documentation is useful to the widest array of people, and how to get the most out of the time you spend writing it.
Attended by: Jeff Till, Paul Johnson, Dave Rolsky (autarch), Henry Van Styn (vanstyn), Upasana Shukla, Chuck Hardin, Brad Lhotsky, Adam Engle, Doug Bell (preaction), Karsten Schiela, Karsten Schiela, Russ Brewer (Russ), Eric Ellis (jellisii), Leonard Harris,