Re: Documenting the user interface
In terms of rational reasons, see John Rosberg's post in this thread.
In terms of real-world experience: If the documentation fails the
"completeness test" imposed by management or by QC or by a potential
customer, then the documentation has failed. No appeal. No chance to
explain.
I suppose if you have some sort of corporate
requirement for absolute, positive completeness
of every jot and tittle, then you would have to
go the "document absolutely everything" route.
However, everywhere I've worked, the doc people
have been encouraged to create documentation
that serves the user best, with input from
Marketing, Engineering, etc.
I still maintain that in documenting the tasks
the user performs with the product, you are most
likely to document all of the items in the
interface in the way that is most meaningful
for the user.
-- 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.
Follow-Ups:
- Re: Documenting the user interface, Gene Kim-Eng
References:
RE: Documenting the user interface: From: Jim Shaeffer
Previous by Author:
Re: Misc: Writing warnings
Next by Author:
Re: Documenting the user interface
Previous by Thread:
RE: Documenting the user interface
Next by Thread:
Re: Documenting the user interface
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads