RE: Benchmarking Technical Documentation

Subject: RE: Benchmarking Technical Documentation
From: "Tracy Boyington" <tracy_boyington -at- okcareertech -dot- org>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 23 Jul 2001 13:59:11 -0500

I think we'd all agree that content is more important than format, and it's more important to be technically correct than grammatically correct. Assuming you can't do both, that is.

But I suspect that, as TWs, some of us are pickier when it comes to dismissing non-content errors because they lead us to doubt the content. For example, when I read a document that consistently uses "you're" instead of "your," part of me says it doesn't matter but another part of me says "If they couldn't even bother to use Word's grammar checker, what else did they not bother with?"

When I was 16, my dad took me shopping for my first car. After checking out a car that was FSBO, he asked if I had noticed a radio knob was missing. I said yes, I saw that, but I've seen replacement knobs at Wal-Mart so I know it will be really easy and inexpensive to fix. And he said yes, that's right, it *is* really easy to fix. And if the owner didn't fix the cheap and easy things, are you confident that she took care of the more difficult and expensive things?

To some people, a readable format and correct grammar and spelling are just pinstripes. They can make a product look nice, but they're purely optional and have nothing to do with how well it works. But *sometimes*, to me, they're radio knobs, and if they're missing, they make me wonder how much care went into the entire document. So, what about the rest of us? What sets off your alarm? Are there any non-content errors that would cause you to distrust the content?

And, of course, some of us also realize that being technically correct doesn't make a document usable. I could design the greatest widget on earth and dump everything I know about it into one huge document. I could explain how I built the widget, discuss its molecular structure, and describe exactly how the laws of physics affect it. But if you can't find the step that says "how to turn on the widget," it doesn't matter how correct it is, because you can't use it.


====================================================
Tracy Boyington tracy_boyington -at- okcareertech -dot- org
Oklahoma Department of Career & Technology Education
Stillwater, OK http://www.okcareertech.org/cimc
====================================================

>>> Katherine Turner <katherinet -at- csl -dot- com> 07/23/01 01:22PM >>>
I have to agree with Richard Smith and Andrew Plato, content is more
important than format.



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

*** 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: New Poll Question
Next by Author: RE: If you could ask your users a question...
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