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:"John Rosberg" <jrosberg -at- interwoven -dot- com> To:"Janice Gelb" <janice -dot- gelb -at- sun -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 11 Jan 2007 15:12:30 -0600
While Janice is right, that products are purchased to achieve a specific
goal, not all users had input into, or knowledge of, the purchasing
decision -- this is especially true of enterprise wide applications,
where the purchasing decision can be made on another continent by folks
that don't know the user community at all.
Also, while task-oriented procedures and/or work/flow descriptions can
be very helpful, indeed, it is not always possible to know how someone
is going to use the product.
Which is, of course, why we all get paid the big bucks, and have those
parking spaces with our names on 'em, right?
As usual, one size rarely fits all.
John Rosberg
-----Original Message-----
From: Janice Gelb [mailto:janice -dot- gelb -at- sun -dot- com]
Sent: Wednesday, January 10, 2007 6:05 PM
To: TECHWR-L
Subject: Re: Documenting the user interface
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-