RE: Benchmarking Technical Documentation

Subject: RE: Benchmarking Technical Documentation
From: Sean MacRae <sean -at- rcp -dot- co -dot- uk>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 24 Jul 2001 10:22:11 +0100

Richard,

> This shouldn't be very hard to communicate. All good docs
> share one common
> thread. They contain the information users need. That's all.

And can find it, recognise it and understand it without ambiguity -- this is
supported by good design, good writing, decent indexing, etc.


[...]
> mean that most users, while they will gleefully point such
> errors out to
> you, care most about finding the content they need. That's
> what makes a
> document good. Usability, readability, format, and style are
> all icing on
> the info-cake.

I think anyone who works with words is more sensitive to errors such as
typos, and don't realise how few are spotted by regular readers. A common
complaint from professional proof readers is that they no longer enjoy
recreational reading, as the typos spoil it for them. UK readers of this
list will appreciate how much of a chore reading _The Guardian_ becomes.

After a couple of months reading proofs as a production editor, I was
spotting typos flashed up on the TV in on-screen captions. Still spot 'em a
mile off.

But strangely enough, I could not spot any of the typos that made it into
the first manual what I wrote...


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

*** 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: usability specialists and grad schools
Next by Author: RE: techwr-l digest: July 24, 2001
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