Re: Task-based versus UI-based documentation

Subject: Re: Task-based versus UI-based documentation
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TechWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 7 Aug 2014 10:42:10 -0700

Best case, UI-based documentation is confusing because instructions on
accomplishing any task that uses multiple parts of the UI is scattered
around so the user has to figure a lot out for themselves.

Worst case, it's just a narrative of the UI that adds no value. I've
thrown out a lot of docs like that and rewritten them from scratch.

"For context sensitive, UI based - you hit help on a screen and you
want to know what THAT screen does and what the different fields are."

It's not nearly that simple.

1. You don't know how the user got to the topic. Maybe they pressed
F1, maybe they searched the help, maybe they clicked a link in another
topic, maybe they're browsing the TOC, if the help is on the web maybe
they got there from Google.

2. Maybe the user knows how to use the thing and is just looking for
the menu sequence to get to it.

3. Maybe the user is doing something that uses more than one part of
the UI and is trying to figure out where to go next to accomplish the
rest of the task.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Task-based versus UI-based documentation: From: Cardimon, Craig

Previous by Author: Re: web-safe fonts & characters 2014
Next by Author: Re: web-safe fonts & characters 2014
Previous by Thread: RE: Task-based versus UI-based documentation
Next by Thread: RE: Task-based versus UI-based documentation


What this post helpful? Share it with friends and colleagues:


Sponsored Ads