Re: Documenting the user interface

Subject: Re: Documenting the user interface
From: Janice Gelb <janice -dot- gelb -at- sun -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 11 Jan 2007 11:05:18 +1100

Kay Honaker wrote:

Try to be as task-oriented as possible. In other words, don't just go through each button or tab and tell what they do. Instead, describe a work flow that takes the user through the tasks for which she will use the software.
On the other hand, you need to cover all the buttons and tabs and fields and functions. Otherwise, the user will wonder why they exist (with good reason).

Not sure I agree that "users will wonder" why things exist in
the user interface. I think most users buy a product to
accomplish some task and with very few exceptions, their
interest in the interface is solely related to how to use
it to accomplish that task. That's why I agree that you
don't need to describe every button, tab, field, etc. They
should only be described in the tasks in which they are
used to accomplish something.

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address


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

WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l

Create HTML or Microsoft Word content and convert to Help file formats or printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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


Follow-Ups:

References:
RE: Documenting the user interface: From: Kay Honaker

Previous by Author: Re: Documenting the User Interface
Next by Author: Re: Documenting the user interface
Previous by Thread: RE: Documenting the user interface
Next by Thread: RE: Documenting the user interface


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


Sponsored Ads