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:"Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 11 Jan 2007 14:57:18 -0000
Which is why I said "depends on the user". If your user base has an
expectation level of such documentation, then to them it is a bug that
button X on screen 4329 isn't mentioned anywhere.
I guess there might be a further point to be discussed here about the role
technical documentation can play in educating users to explore and learn but
not today.
G
-----Original Message-----
From:
techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr
-l.com]On Behalf Of Kay Honaker
Sent: 11 January 2007 14:45
To: Janice Gelb; TECHWR-L
Subject: RE: Documenting the user interface
The features in the software are all there to serve someone, otherwise, why
are they there?
I have had multiple users submit "bugs" for buttons that are not described
in the documentation. Just got another one yesterday.....
-----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 Janice Gelb
Sent: Wednesday, January 10, 2007 5: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 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
Gordon -dot- McLean -at- grahamtechnology -dot- com -dot-
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.
________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
________________________________________________________________________
Graham Technology plc http://www.grahamtechnology.com
________________________________________________________________________
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
