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.....
Mike Starr wrote:
> Procedural documentation is absolutely essential... we need to help the
> user accomplish the tasks they bought the product to do.
>
> However, to leave users twisting in the wind, resorting to "exploring
> and learning", because there is no reference documentation is
> unconscionable. Every button, checkbox, radio button, drop-down list
> box, etc. in a user interface needs to be explained somewhere in the
> documentation set. Not only that but it must be easy for the user to
> find that explanation when he/she needs it.
>
I fail to see why these are mutually exclusive.
Buttons/fields/menus and so on are there because
the user needs them to perform some task with the
software. Therefore, if you cover all the tasks
that the user is likely to perform with the
software, all the GUI elements are going to be
covered in the context in which the user needs them.
As others have said, if a button isn't documented,
it's because the button is not useful. If the
documentation is thorough about covering the tasks
for which the software is used, then imho any bug
that is submitted about why a button was not
documented should be referred back to the design
engineers. (I know, I know, in our dreams :-> )
-- Janice
**********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
"These are my opinions. If they were the Biblical
truth, your bushes would be burning -- Randy Lander
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
References:
RE: Documenting the user interface: From: Kay Honaker
Previous by Author:
Re: Documenting the user interface
Next by Author:
Re: Misc: Writing warnings
Previous by Thread:
RE: Documenting the user interface--unnecessary features?
Next by Thread:
RE: Documenting the user interface
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads