TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
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-
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-