TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
When I started many moons ago, I was told to treat you audience as
idiots unless you know different. If they are, then they'll get what
they want; if they're not, they me be a bit peeved but they'll skim and
get what they want.
The important thing here is 'unless you know different'. Ideally we'll
know exactly who we're writing for but the trouble is there's no such
thing as a truly homogenous audience. Usually you pitch it at the
'majority' level, covering as much of your audience as possible. It's
the old know you audience principle - once you know that you know the
level you need to write to. Even then, if sixth grade means keeping it
simple, I'm all for it - give them what they need.
It can be simple, regardless of the audience (it's all relative!). For
example, a procedure may include 10 steps:
1 Do X
2 Do Y etc
Each step may have an accompanying description, screenshot, jargon
explained etc and this is determined by the 'level' of the audience. For
novices you might include a lot, including screenshots at each stage to
let them see they're doing it right. At the power user end you might
include no screenshots etc.
Damien Braniff
Sr. Technical Writer
damienb -at- asg -dot- com
Waterfront Plaza
8, Lagan Bank Road
Belfast, N. Ireland BT1 3LR
Tel: +44 (0) 28.9072.3124
Fax: +44 (0) 28.9072.3324
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-