"taboo engineering techniques" (RE: Modularization of Documentation)

Subject: "taboo engineering techniques" (RE: Modularization of Documentation)
From: "Kevin Cole" <kccole -at- fuse -dot- net>
To: "'techwhirlers'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sun, 4 Jun 2006 12:49:08 -0400


In discussing the analysis of technical content you said: "Unfortunately,
you are going to find very little written material in the TW community on
how to properly modularize your work. It involves use of taboo engineering

Do you mean to say that engineering techniques are taboo within the "TW"
community? The IEEE does have a society for technical writers, you know.
This attitude doesn't do much for the credibility of the "TW Community" at

A tech writer's involvement in a software engineering project can be as
superficial or as technically challenging as your skills demand. You can be
essentially a highly-priced amanuensis, taking programmers' notes and typing
them into highly-detailed MS Word template files. Or you could participate
in the analytic process, model the documentation as the system itself is
modeled, involve yourself in system testing as well as end-user QA, and in
general bring tremendous value-adding skills to the project that extend from
and expand upon your unique perspective and background.

Tech writers who pride themselves on staying clean of all those icky
engineering details don't add much value. They tend to cheapen the
perceptions of our public.

I'm hoping that's not the attitude you were espousing!


.o.| Kevin Cole
..o| Cincinnati, Ohio
ooo| USA


WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Modularization of Documentation: From: Tony Markos

Previous by Author: RE: tech communication career
Next by Author: pace (RE: "taboo engineering techniques" (RE: Modularization of Documentation))
Previous by Thread: Re: Modularization of Documentation
Next by Thread: Re: "taboo engineering techniques" (RE: Modularization of Documentation)

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

Sponsored Ads