Professional Documents
Culture Documents
3 Techniques Needs in Technical Writing
3 Techniques Needs in Technical Writing
Mechanism - is an assembly of movable parts having one part fixed with respect to a frame of
reference and designed to produce an effect.
Process description includes sequence, instructions and procedure; however, only instruct if you expect your reader to perform the process you describe. Try to keep separate these two concepts: "How to do something" and "How something occurs" The first calls for instructions or procedure; the second, for sequence.
Classification - involves grouping things together (on the basis of similarities) and
dividing them (according to differences). Classification assists in the complete consideration of a topic .Note the danger of Faulty Coordination.
Partition - is the act of dividing things into their component parts; very similar to
classification, and an inevitable part of mechanism description and process description. Partition could be spatial (how each part looks) or functional (how each part works).
Definition - uses words to fix the meaning of a thing -- to make it "definite". The
short definition (a paragraph or a single sentence) is essential to technical writing.
For instance, the Mechanism Description and the Process Description each begin with a call for a definition. A definition answers the question "what is it?" Good definitions employ the following formula: Species = genus + differentia thing to be defined = group to which the thing belongs + specific details that separate it from other things in its group A batten is a tapered piece of wood that fits into a pocket in the trailing edge of a sail, helping it hold the shape that allows it to propel a boat.
Sometimes definitions might be much longer than one sentence, in which case you are still trying to answer "what is it?" but will be using most other patterns to help answer it: you can define by describing, classifying, comparing, etc.
disambiguate (to use a word my father introduced to me the other day). Your core job will consist of taking complicated things and trying to explain them in easy-to-understand ways. You cant just pass off an explanation you only half understand. Writing about something (as opposed to talking about it) requires you to understand it thoroughly. Avoid passive sentences and long constructions. Go from old ideas to new. Define acronyms and avoid assumptions about what the user knows. Make the reader feel smart.
4.
patience, youll never make it. I think 80 percent of IT work consists of problem solving. What do you do when you cant figure out how to do something? Do you slam your fist into your keyboard? Do you scream and curse when you cant immediately figure something out? Its amazing how you can see a seemingly impossible problem through with patience and persistence
Ability to interact with SMEs - I talked about this in my last pod cast on Tech
Writer Voices. Interacting with SMEs is one the most overlooked skills in technical writing. You have to be part investigative reporter, part journalist. You cant be shy about going after certain people to extract information. And
you cant be too proud to ask the dumb technical questions that make engineers do double takes. A lot of this interaction can come about if youre lucky enough to simply sit near SMEs.