Re: Swaggin' for Dollars

Subject: Re: Swaggin' for Dollars
From: Damien Braniff <dbraniff -at- iss-dsp -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 07 Apr 2000 08:52:41 +0100

>> Perhaps not the best choice of words by Andrew, but as to the sentiment... I
>> always remember some advice I was given when I first started writing (by a
>> very senior writer and excellent mentor) - if you have no idea who your
>> audience is then treat them as idiots, as if they know nothing about what
>> you're writing. If they DON'T, then they'll be happy and get the info they
>> need. If they are much more experienced they may think the docs are a bit
>> simple/condescending/whatever then they will skim read the docs and STILL
>> get the info they need. Fortunately, we're not usually in such dire straits
>> and we generally know (at least roughly) at what level to pitch the
>> documentation and it's usually geared to the lowest level of knowledge. If
>> we've the luxury of time (who has?!) we can make the docs 2/3-tier so the
>> readers can enter at their own level but sometimes you just gotta drop down
>> to the bottom level. The last job I had the documentation was for access
>> control systems with the software being installed/adminstered by people with
>> NO prior PC knowledge (some that came for training didn't know what a mouse
>> was) right up to system administrators
>
> Damien Braniff

-
Damien Braniff
Technical Author
Integrated Silicon Systems Ltd. Tel: +44 28 90 50 4000
50 Malone Road Fax: +44 28 90 50 4001
Belfast BT9 5BS Web: www.iss-dsp.com






Previous by Author: Sample RFPs
Next by Author: Re: Swaggin' for Dollars
Previous by Thread: RE: Swaggin' for Dollars
Next by Thread: Re: Swaggin' for Dollars


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


Sponsored Ads