RE: Documenting the user interface

Subject: RE: Documenting the user interface
From: "Kay Honaker" <khonaker -at- accela -dot- com>
To: "Kapoor, Shelly" <SKapoor -at- imf -dot- org>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 10 Jan 2007 10:39:55 -0700

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).

Kay


-----Original Message-----
From: techwr-l-bounces+khonaker=accela -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+khonaker=accela -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Kapoor, Shelly
Sent: Wednesday, January 10, 2007 10:33 AM
To: TECHWR-L
Subject: Documenting the user interface


I have to document a couple of user interfaces. What do you thin is the
best way to proceed? Could you please point me to some tips/ideas for
documenting user interfaces.


Thanks
Shelly
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 khonaker -at- accela -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/khonaker%40accela.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.

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

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:

Previous by Author: RE: Your To-Do List
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