Re: Examples of good tech writing?

Subject: Re: Examples of good tech writing?
From: "Damien Braniff" <Damien -dot- Braniff -at- asg -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 18 Jan 2006 09:49:09 -0000

Re 'Dummies' etc, I think it comes down to the standard TW mantra - know
your audience. They are, by definition, aimed at a totally novice
audience and for that audience they're quite appropriate. They're not
'techie' books and the reason TWers can find them a trifle annoying is
that we're often somewhere in the middle - not novices and not really
techies. Because we have to be quick at picking technology etc up
quickly we probably tend more towards the techie books :-).
One of the best books I came across (many, many years ago!) was a book
on programming when I first went to university. It was a book on Basic
(gives an idea of how long ago <g>) and it was very informally written,
legible script font and it had little drawings of ants (I think)
scattered throughout the book highlighting common bugs! I'd find it
irritating now but at the time it was great - they were like a 'graphic
index' for common errors.

Damien Braniff | Sr. Technical Writer
damienb -at- asg -dot- com

Technical Communications
Waterfront Plaza
8, Lagan Bank Road,
Belfast, N. Ireland BT1 3LR
Tel: +44 (0) 28.9072.3124
Fax: +44 (0) 28.9072.3324

End-to-End Technology Management


Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

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

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: Scoping a doc project
Next by Author: Effective mechanism to gather end-user feedback?
Previous by Thread: RE: Examples of good tech writing?
Next by Thread: Online- Documentation Project Managment Course

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

Sponsored Ads