RE: Due care (was RE: Benchmarking Technical Documentation)

Subject: RE: Due care (was RE: Benchmarking Technical Documentation)
From: "Swallow, William" <WSwallow -at- courion -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 24 Jul 2001 16:03:40 -0400

Roy wrote:
:: If information is missing or incorrect, the document is flawed.

:: If the information is present and correct, but:
:: - the user can't find it using the "standard" tools (e.g. index, table
:: of contents), or
:: - the user can't understand it because of non-/sub-standard grammar and
:: style,
:: then the document is flawed.

Documentation will ALWAYS be flawed. Perfection (absolute perfection) is
subjective. You can quantify grammar, completeness of info, consistency in
presentation, but layout and delivery will always be qualitative factors.

My $0.02

*****************
BILL SWALLOW
Technical Writer
C O U R I O N C O R P O R A T I O N
1881 Worcester Road
Framingham, Mass. 01701
T E L * 508-879-8400 x316
F A X * 508-879-8500
www.courion.com
*****************

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Learn about tools and technologies for user assistance developers at
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com


---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: Tech. Writing Assignments
Next by Author: RE: HATs for Context-Sensitive Help
Previous by Thread: RE: Due care (was RE: Benchmarking Technical Documentation)
Next by Thread: RE: Due care (was RE: Benchmarking Technical Documentation)


What this post helpful? Share it with friends and colleagues:


Sponsored Ads