Re: Structure vs. Substance

Subject: Re: Structure vs. Substance
From: "Christensen, Kent" <lkchris -at- sandia -dot- gov>
To: "'TECHWR-L'" <TECHWR-L -at- LISTS -dot- RAYCOMM -dot- COM>
Date: Tue, 13 Jun 2000 09:17:28 -0600

The most interesting part of this discussion to me is to contrast Tim
Altom's "levels of thinking" with Michelle Davis' "(my structure) is all
stored in the enormous database called my brain."

Clearly this is technical writing and not short stories or novels, and
structure has its place. Surely each chapter in a manual or manual in a
series should be organized in the same manner; notes, cautions, or warnings
should be presented the same way every time, etc. And, I suppose just as
clearly, this stuff can be basically accomplished either following one's
internal guidelines--i.e., skills, experience--or by following a cookbook.

I have to say that tools such as Tim espouses are good things and serve as
communication vehicles for use when working with those unfamiliar with this
field and more importantly as checklist or reminder or review material for
those who are or learning material for those in training to be.
Nevertheless, I offer that skill is most important and caution that
structure can be seen as a "magic bullet" by the uninformed that, for
example, convinces them that "secretaries" can do technical writing given
structure.

In addition, and it seems more relevant to Tim's position, "structure,"
i.e., a level 3 approach, is surely a useful tool for selling contract
technical writing services (and that's not a bad thing). I can see myself
in the position of having on staff a writer or writers who are creative and
out-of-the-box thinkers. When it comes to hiring contract writers, on the
other hand, I may assume a "practical" mode and look for those with tools
for getting the job done quickly and efficiently.

For internal staff for sure and I suppose just as surely for procured
writing, perhaps the best "structure" is that provided by testing the
writing with potential users--does it work? Hey, if a "hip shooter" can
please the user, that seems all the "structure" required, and perhaps the
(first) term needs rethinking. Just "a pro" might do.

And, as postscript and perhaps an expanded direction for this thread,
"structure" so far sounds like something used more often in situations where
the writer is called in after the product or process is developed. I sure
do prefer the situation where the writer is part of the product design and
development process from its inception. Where the writer has some product
knowledge; maybe even engineering qualifications or the like along with the
writing qualifications. This is likely a different kind of "structure"
altogether, and ... how often do contract writers participate in this
fashion?





Previous by Author: Re: Insure vs Ensure
Next by Author: Re: Tech Writer screening questions
Previous by Thread: Process, process, who's got a process?
Next by Thread: structure vs. substance


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

Sponsored Ads


Sponsored Ads