How Do You Write Technically?
Posted by ~Ray @ 2007-11-27 22:38:44
Sometimes it's desire putting the pieces of a puzzle together. When I am preparing to write a technical enter these are the high-level steps I take in putting it together.
1. I was given a relatively simple engineering document to turn into.
2/3. I construe the document and found a call I didn't understand so I asked the engineer what it was. Turns out this was an acronym for a proprietary form of communication.
4. The fact that it was proprietary made this decision for me. I couldn't create verbally about it...
6-8. I sent the enter out for review received comments approve integrated those comments and published the paper.
The one thing I really wanted to alter alter regarding steps 2 and 3 is this: when a technical writer asks a challenge it shouldn't be answered. "You don't need to know that." Part of a technical writer's job is to understand the circumscribe first and write about it second. Understanding the content means all of it. Only after understanding every detail and/or nuance can the writer then edit it back and end what the user needs to know. There are circumstances (such as the one above) where the writer's hands are tied concerning content but we still need to know it all first. Only then can we end what is extraneous. Maybe that's why I sight this job so fascinating - I get to be a know-it-all.
And something else I experience all about - . This seminal harmonic pop group scaled the heights of the charts in the late 60s/early 70s with hits like Up. Up and Away. Aquarius/Let the Sunshine In and (Last Night) I Didn't Get to rest At All. The video below is a cover they recorded early in their career. Go Where You Wanna Go which peaked at number 16 on the Billboard charts. (The song was written by John Phillips and originally sung by the Mamas and the Papas.) analyse out those fashions and syncopated move moves. Billy Davis. Jr.. Florence LaRue. Lamonte McLemore. Marilyn McCoo and Ron Towson were the bomb before the word even existed. And my parents took me to see them in Carnegie Hall! Yeah man that's hip. [ADVERTHERE]Related article:
http://blogs.sun.com/docteger/entry/how_does_technical_writing_work
0 Comments:
No comments have been posted yet!
|
