keep it simple: streamline your documentation to make it more effective

Post on 05-Dec-2014

1.840 Views

Category:

Technology

0 Downloads

Preview:

Click to see full reader

DESCRIPTION

A presentation given by Scott Nesbitt of DMN Communications at the Free Software Open Source Software Symposium (FSOSS 2009) on October 30, 2009.

TRANSCRIPT

Keep It SimpleStreamline your documentation

to make it more effective

Scott NesbittPartner, DMN Communications

Keep it simple

Are we giving users the help they need, in the way they need it?

1.0 + 2.0 = 1.5?

Go minimal

Ditch the manual

Don't be afraid to cut

Start at the front

Think outside the ToC

Think in terms of topics

Docs as conversation,

literally

Write tightly

Sometimes, more is better

People are looking for advanced tips and tricks. They're not looking for the basics. They're looking for things that will give them more of an edge. ­ Tim O'Reilly

Questions?

Web site:www.dmncommunications.com

Presentations:www.dmncommunications.com/presentations.php

Blog: www.dmncommunications.com/weblog

SlideShare repository:www.slideshare.net/DMN.Communications

Twitter:www.twitter.com/dmnguys

Resources on the Web

top related