Technical Writing Getting good at writing briefly Technical

Technical Writing Getting good at writing briefly

Technical Writing Overview �What is technical writing? �Have you ever done any technical writing in your classes? �What kinds have you tried?

What is it? �“Technical writing conveys specific information about a technical subject to a specific audience for a specific purpose…The words and graphics of technical writing are meant to be practical; that is, to communicate a body of factual information that will help an audience understand a subject or carry out a task. ” �Michael Markel, Director of Technical Communication, Boise State University

Examples?

Characteristics of good Technical Writing �Clear: easily understood by intended audience �Accurate: factual, correct, free from bias �Comprehensive: all necessary information is included �Accessible: headings, index, table of contents �Concise: clear without excess verbiage �Correct: follows grammatical

Practice �Most technical writers create instructions more than any other kind of writing. Often the writer does the writing, researching, editing, illustrating and formatting (just like you are going to do!) �You are working for a company that makes mouse traps. As the writer, you given the project of writing instructions for setting a mouse trap. You will each get a trap (new!) and bait (also new) to use in your research.

Process �Each of you will get a trap and bait and a small index card to write your instructions on. You may only use this limited space because of packaging. �Because of the timeline the company is under to get these traps on the market, you will have 10 minutes to complete your first draft. Deadlines are a big part of a technical writers’ life- please work quickly and quietly.

Debrief �Did anyone do “research” before writing? Why or why not? �Did you use bait or not? Can bait be stolen? �Did anyone get their fingers snapped? How can this be avoided? �Why are illustrations important? �How many steps did you have? How many words in the steps?

Sample instructions �Actual instructions are only 1. 5 inches by 4 inches…and 3 languages! � 3 numbered steps ◦ 29 words plus illustration Round two…

Editing and Revising �Only 4 steps � 12 words per step max �Warning can be in addition � 5 mins to write, label and warn

Editing discussion �How did editing go? �Did you stay within the guidelines: 4 steps and not more than 48 words? �Could someone easily follow your instructions? �Lets look at the “read” instructions

How are these? �No warning �Step 1 is really steps �Is doesn’t mention pressing the bait firmly �The word “engage” might not be the best choice. What would be better? �The last step doesn’t tell where to set the traps. �What about the capital letters? Are they necessary?

Application What do you know that you didn’t know before? How can this be applied to the Zanzibar Project? �Next steps…writing, researching, designing, editing.