1 / 9

Enhancing Documentation: Strategies to Overcome Writer's Block and Engage Readers

In this insightful session, Matthew Howse presents Whitney Beth Potsus's article "Adding Life to Your Documentation," discussing how to overcome writer's block and keep readers engaged. The overview covers key strategies such as creating “The Least You Need to Know” lists, which provide essential information without overwhelming detail. It emphasizes the significance of well-structured documentation, including checklists and graphics to enhance understanding. Learn best practices for improving your writing and discover effective ways to communicate with your audience quickly and clearly.

maitland
Télécharger la présentation

Enhancing Documentation: Strategies to Overcome Writer's Block and Engage Readers

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Introduction Presenter: Matthew Howse Date: 9/23/08 Article: "Adding Life to Your Documentation" Author: Whitney Beth Potsus

  2. Overview • Ever get caught in a writers block • Doing the same thing day in and day out • How to get past writers block and keep the readers attention.

  3. N- list N- list, no more that 15 main points keep it brief • Can be links off the 15 main points • K.I.S.S. keep it simple stupid. • “The Least You Need to Know” Lists

  4. Use to-do Lists, Recipes, Checklists. Described as shopping list documentation • Having everything you need before you follow a procedure. • Checklist what to do before the next step. • Great for assemblies, installation, and procedural directions.

  5. “The least you need to know” lists. Giving you the bare minimum of the topic • Not very in-depth • Just good enough for a basic understanding

  6. Telling the users what they’re supposed to do. Very technical, usually wanting the user to do something. • Best/Common Practices • Well written can be very good • Poorly written can result in 9 support calls per month

  7. Graphics Charts, Graphs, tables, and pictures. • Good for comparing objects • Good to grab the reader, more likely to read the article • Making it quick and easy

  8. Quizes and other self-tests Self explanatory way of explaining getting you’re point across. • Easy/hard • Long/short • Fun/serrous • Useful in training classes

  9. Conclusion • Main points • “What matters is that they read and felt that they walked away with enough knowledge to be immediately productive.” • Catching the readers attention and holding it. • Effective and fast ways to get your point across. ??Questions??

More Related