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.
Subject:RE: What is More Important? From:"Steve Cavanaugh" <scavanaugh -at- nat-seattle -dot- com> To:<dgreen -at- associatedbrands -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 15 May 2007 14:27:10 -0700
Technically accurate always trumps style when it comes to manuals used
in life or death circumstances. A manual for a 747, for example, had
better be technically accurate above all else.
Steve Cavanaugh
-----Original Message-----
From: techwr-l-bounces+scavanaugh=nat-seattle -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+scavanaugh=nat-seattle -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of richard -dot- melanson -at- us -dot- tel -dot- com
Sent: Tuesday, May 15, 2007 2:23 PM
To: dgreen -at- associatedbrands -dot- com; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: What is More Important?
May I ask everyone a question. What is more important, having the
content of a manual written well or having the content of a manual
technically accurate, and no they are not mutually exclusive :-)
Please may I ask that you just pick one or the other, I know that we can
list a myriad or reasons why each is important and at times mandatory, I
am just asking everyone to decide and pick one.
I am fortunate enough to have been on both sides of the fence. I was a
Product Support Engineer for years working on Ion Implanters trying to
use the manuals available and now I am the Writer of those manuals.
If this has been asked before, please accept my apologies and point me
to where the answer is stored. I really appreciate your help Everyone,
thank you.
Richard Melanson
Technical Writer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 scavanaugh -at- nat-seattle -dot- com -dot-
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-