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: STC Letter to the Editor From:Shea Michael EXT <Michael -dot- Shea -dot- extern -at- icn -dot- siemens -dot- de> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 5 Nov 2002 13:38:04 +0100
Of course this is minutia as well. I was merely trying to make the point that content does not guarantee a good document. If I ask you how to spell cinamon and you e-mail me /usr/dict/words, your delivery has been technically accurate but useless in its presentation.
You can also do the same with structure and format. Spend to much time on those and you might render your document unusable or not have enough time to properly develop your content.
Can we agree that this debate does not need to be so black-and-white? Content, structure, and presentation all have value. You cannot have a successful document if you neglect any of them.
-Michael Shea
-----Original Message-----
From: Matthew Donovan
Subject: Re: STC Letter to the Editor
At 12:00 AM 11/5/2002 -0700, TECHWR-L digest wrote:
>Subject: RE: STC Letter to the Editor
>From: Shea Michael EXT <Michael -dot- Shea -dot- extern -at- icn -dot- siemens -dot- de>
>Date: Mon, 4 Nov 2002 15:34:31 +0100
>
>Come on folks. I think we all agree that STC volunteers cannot ever judge
>the technical accuracy. Yes technical accuracy is important. It can be
>life-threateningly important when we are documenting, let's say medical
>equipment.
>
>However, you can have a technically accurate book in which information:
>
><snip>
>* is buried in minutia
Isn't worrying about whether Verdana 12 looks better than Arial 10 a bit of
minutia ?
<snip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
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!
---
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.
