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

22
Keep It Simple Streamline your documentation to make it more effective Scott Nesbitt Partner, DMN Communications

Upload: dmn-communications

Post on 05-Dec-2014

1.840 views

Category:

Technology


0 download

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

Page 1: Keep It Simple: Streamline your documentation to make it more effective

Keep It SimpleStreamline your documentation

to make it more effective

Scott NesbittPartner, DMN Communications

Page 2: Keep It Simple: Streamline your documentation to make it more effective
Page 3: Keep It Simple: Streamline your documentation to make it more effective
Page 4: Keep It Simple: Streamline your documentation to make it more effective

Keep it simple

Page 5: Keep It Simple: Streamline your documentation to make it more effective

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

Page 6: Keep It Simple: Streamline your documentation to make it more effective

1.0 + 2.0 = 1.5?

Page 7: Keep It Simple: Streamline your documentation to make it more effective

Go minimal

Page 8: Keep It Simple: Streamline your documentation to make it more effective

Ditch the manual

Page 9: Keep It Simple: Streamline your documentation to make it more effective

Don't be afraid to cut

Page 10: Keep It Simple: Streamline your documentation to make it more effective

Start at the front

Page 11: Keep It Simple: Streamline your documentation to make it more effective

Think outside the ToC

Page 12: Keep It Simple: Streamline your documentation to make it more effective

Think in terms of topics

Page 13: Keep It Simple: Streamline your documentation to make it more effective
Page 14: Keep It Simple: Streamline your documentation to make it more effective
Page 15: Keep It Simple: Streamline your documentation to make it more effective
Page 16: Keep It Simple: Streamline your documentation to make it more effective

Docs as conversation,

literally

Page 17: Keep It Simple: Streamline your documentation to make it more effective

Write tightly

Page 18: Keep It Simple: Streamline your documentation to make it more effective
Page 19: Keep It Simple: Streamline your documentation to make it more effective

Sometimes, more is better

Page 20: Keep It Simple: Streamline your documentation to make it more effective

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

Page 21: Keep It Simple: Streamline your documentation to make it more effective

Questions?

Page 22: Keep It Simple: Streamline your documentation to make it more effective

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