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.
We want to help users with our docs and to do this we need to:
1. Make the documents look professional - if it looks 'good' it's
more likely to be read, or at least looked at. Bit like wearing a suit
to an interview - first impressions DO count!
2. Next (once you've got them looking!), give them what they need -
the information has to be there and correct.
3. Finally, make it easy for them to FIND what they want - good
structure, toc, index etc.
Bit simplistic perhaps but I think that's it in a nutshell, based on
research I did for my MA some years ago. In a survey I did people said
that the 'look' of a manual tinted how they viewed the doc before they
even opened it. They also said that a 'good' doc had a positive effect
on how they viewed the product as a whole PLUS their view of the company
producing it and, by extension, other products by the company.
So I'd agree with Gene - the docs can definitely be a (albeit
unintentional at times) marketing tool. A couple of respondents said
that they bought further products from the same company based (at least
in part) on the docs. Ditto, some went elsewhere due to the poor quality
of the docs.
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
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-