RE:STC letter to the editor

Subject: RE:STC letter to the editor
From: "Damien Braniff" <DBraniff -at- amphion -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 4 Nov 2002 08:24:18 -0000


There IS merit in 'artistic' presentation. Documentation should be, first and foremost, useful. To be useful it must be accurate and the information easy to find (I don't class this as 'artistic', simply good, basic, TW practice). Where I see the 'artistic' bit coming in (not always needed!) is in getting the user to actually READ the documentation. Good design, layout etc should be a part of this but the 'artistic' style is also important (Dummies etc). In some cases good navigation etc is sufficient to encourage the reader, in other cases you need to tempt them into the document. It all boils down to knowing the user (yet again):

* Are they engineers looking only for answers to particular questions? Take them to the information they need as quickly as possible, and make it easy to get there

* Are they non-techies? Then hold their hands and lead them to the information, taking as long as needed.


Damien Braniff
Technical Writer
Amphion Semiconductor Ltd.
50/51 Malone Road
BT9 5BS Belfast, Antrim
Northern Ireland

Tel: 028 9050 4000
Fax: 028 9050 4001
E-mail: dbraniff -at- amphion -dot- com
Web: www.amphion.com




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

---
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: Posting my technical writer resume
Next by Author: RE: Proof that content is more important than style
Previous by Thread: Re: STC Letter to the Editor
Next by Thread: Re: STC Letter to the Editor


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


Sponsored Ads