Re: Must documentation always follow the UI?

Subject: Re: Must documentation always follow the UI?
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Sep 2015 12:43:42 -0700

If this *were* task-based, and the task was filling out a form for an
initial configuration, then I'd use the "tab" order of the fields.

Documenting self-explanatory UI elements such as "path" or "file name"
is clutter unless there's some value to add to what the user sees in
the UI. E.g. "file name: the name of the file" is clutter, but "file
name: 128 characters max." might be useful.

On Wed, Sep 23, 2015 at 12:34 PM, Mike Starr <mike -at- writestarr -dot- com> wrote:
> It's not always all about task-based documentation. There is a time and
> place for reference documentation. At some point, users need to be able to
> understand every UI element even when we don't provide them with
> documentation for a task that uses that particular element.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW

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

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:
Must documentation always follow the UI?: From: Cardimon, Craig
Re: Must documentation always follow the UI?: From: John G
Re: Must documentation always follow the UI?: From: Mike Starr

Previous by Author: Re: Must documentation always follow the UI?
Next by Author: Re: Learning XML
Previous by Thread: Re: Must documentation always follow the UI?
Next by Thread: Re: Must documentation always follow the UI?


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

Sponsored Ads


Sponsored Ads