Language Studies and Academics Characteristics of Technical Writing

Language Studies and Academics Technical Writing Technical writing is a natural partner to academic writing. It is descriptive, creative, and expository, but the format is different and the standards are higher. Technical writing requires 100% accuracy.

Language Studies and Academics Ø Technical Writing Technical writing: the composition that is used by professionals in jobs where precise scientific, mechanical or procedural information must be understood. Journalism: the composition that is used to inform readers about social events. Narrative: the composition that is used to tell about events; storytelling that makes the reader feel emotions.

Language Studies and Academics

Examples of Technical Writing Action Plans Advertisement Agenda Audit Report Book Review Brochure Budget Business Letter Business Plan Catalog Contract Critique Data Book or Display Description Diagram, Chart, or Graph Editorial Feasibility Report Field Test Report Incident Report Informational Form Informational Poster Informative Summary Instructions Interview Questions Itinerary

Language Studies and Academics Job Application Job Description Lesson Plan Letter of Inquiry Letter of Recommendation Magazine/Newspaper Article Marketing Plan Memo Meeting Minutes Newsletter Observation Report Performance Evaluations Persuasive Proposal Position Paper Product Comparison Proposal Questionnaire Research Report Résumé/Portfolio Scientific Paper/Report Survey Test Transcription Training Manual Travel Guide Web Page Work Order

Language Studies and Academics Characteristics of Technical Writing 1. Exact language – special terms 2. Definitions: occupational terms or specialized language 3. Measurements and units : 22mm

Language Studies and Academics Characteristics of Technical Writing 1. Visuals – diagrams, charts, and graphs are used 2. Research – indicates how information was generated 3. Ethical – allows reader to see the all aspects of ideas

Language Studies and Academics Characteristics of Technical Writing Computers are not a particularly forgiving breed. The wrong key struck or the wrong command entered is almost sure to avenge itself on the inattentive user by banishing the document to some electronic trash can. On MK950 terminals, the BREAK key is adjacent to keys used for text editing and special functions. Too often, users inadvertently strike the BREAK key, causing the program to quit prematurely. To prevent the problem, we have modified all database management terminals. Shows emotion / opinion and imagination Detailed, unemotional and uses exact terms Journalism Technical Writing

Language Studies and Academics Reading Technical Documents 1. Understand the intended reader: (non- technical? Highly-technical?) 2. Use the visuals to get the full idea 3. Read the document 3-4 times

Language Studies and Academics Reading Technical Documents 1. Consider how accurate the information is 1. Decide what parts of the document are useful to you (How are they useful?)

Language Studies and Academics Technical Documents: TAKING NOTES People who work in an industrial profession must be proactive: they are thinking and acting constantly to predict and solve problems. Proactive professional employ notes to record what they understand and help them put it into words.

Language Studies and Academics Technical Documents: TAKE NOTES Keep the notes in a safe file or folder Write important observations in the margins of copies or drafts Be exact – don’t just write “important”; write why a fact is important; e.g. “This shows the cause of …” Use a highlighter to mark portions of the text that have the main evidence: this will help you find it later, if you need it. Notice when a text uses special fonts, colours, numbers, units, or symbols.

Language Studies and Academics Multimedia Watch the video [search: “Clover coffee machine” Wired]

Language Studies and Academics Let’s think! 1. What precise information does the visual give? 2. What is not given? 3. Is this visual very clear? 4. What kind of technical writing should go with this visual? 5. For what kind of reader is this visual intended? Starbucks ™ new CLOVER ™ coffee machine

Language Studies and Academics Let’s think! 1. Numbers in steps & close-ups are shown. 2. No volumes or names of ingredients & names of device parts are given. 3. Accompanying text should be only a little technical. 4. Descriptions of each step are needed. 5. It is intended for non technical, casual people. SOURCE: Wired magazine Aug pp.88 Starbucks ™ new CLOVER ™ coffee machine