RE: Benchmarking Technical Documentation

Subject: RE: Benchmarking Technical Documentation
From: "Karen E. Black" <kblack_text -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 23 Jul 2001 19:23:54 -0400

Couple letters jutxaposed (just try and pronounce THAT! Can anyone say larnyx?); a few passive constructions here and there; I've pirnted docs that got my editors a few times; incomplete sentences. We knwo what is meant by the context. My fingers make some of the same mistakes writing cursive as they do typing.

For the careful reader, the cumulative effect of typographic and grammatic (or should that be grammatical? Correct me, somebody, before I mistype again!) errors that got by technical review, proofreading, and developmental editing, especially with fast turnaround, are what contribute to the overall impression of whether or not the document is usable. For the careful reader (such as me, not necessarily the competent user), these errors are distracting.

For the purposeful reader, What is it? What does it do? How does it do it? etc., are what counts. He or she barely notices the occasional glitch.

Let's do what we can in the time we have. For the devout among us, what's wrong with a Persian flaw?

Karen E. Black
Technical Writer
www.dhltd.com
--------------------------------------------
Me: "I wish I'd listened to my mother...."
Why, what did she say?
Me: "I don't know, I wasn't listening."
--Unknown female comic

"When you kids were little, you were so cute I could've eaten ya. Now I wish I had."
-- My mother, thanks to Joan Rivers

From: bryan -dot- westbrook -at- amd -dot- com
Actually, somebody did say almost exactly that. Only I remember her
criteria being "a couple" rather than 3.


_________________________________________________________________
Get your FREE download of MSN Explorer at http://explorer.msn.com/intl.asp


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

*** 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: Technical Writers and Negotiating Skills
Next by Author: Project Management/System Lifecycle & the Technical Writer
Previous by Thread: RE: Benchmarking Technical Documentation
Next by Thread: RE: Benchmarking Technical Documentation


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


Sponsored Ads