Last week a student emailed me with some questions about technical writing. I didn’t have time to respond, so I forwarded the questions to the Techwr-L listserv, where 6-7 people responded. One of the responses, from Keith Hood, caught my attention. Keith unfolded what one might refer to as the “dark side of technical writing.” His response is thought-provoking, and it will make you look carefully at your projected career path. Keith is a technical writer in Texas with 18 years of experience.
What steps do you take when writing a document?
Theory: In this order -– identify and define the audience to know their needs for information, develop the requirements for what it needs to cover, work out the review/approval process, plan the structure of the document, work out a coverage plan that says what to include and the level of detail to supply, arrange to have someone else proof and edit, run the doc through the approval process, apply changes from that process, archive it.
Practice: Get told what the boss wants, find out there’s not enough time to do it right, try to throw together some kind of doc development plan in your head, find an existing document that you can use as a template and start cramming stuff into it, simultaneously run around trying to drag information from subject matter experts while you try to build a finished document from scratch, the boss reads it and sends it to the customers, the customers nitpick over it like feuding little old ladies, the boss blames you and has you rewrite it.
How do time and budget limitations affect your writing?
Read the rest of this entry »