Technical Writing PDF
Document Details
Ricky Basilio
Tags
Summary
This document provides an overview of technical writing, including its principles and different types of technical documents such as business letters, contracts, monographs, etc.
Full Transcript
CHAPTER 1 Understanding Technical Writing Source:Pexels Chapter 1 Learning Outcomes Define technical writing Enumerate the end products of technical writing Use as guide the principles of technical writing Define technical communication Explain...
CHAPTER 1 Understanding Technical Writing Source:Pexels Chapter 1 Learning Outcomes Define technical writing Enumerate the end products of technical writing Use as guide the principles of technical writing Define technical communication Explain the qualities of a good English writer Apply the processes involved in technical writing Lesson 1 “All good writing begins with terrible efforts. You need to start somewhere.” -Anne Lamott Technical Writing According to Mills and Walter (1981) Technical Writing is writing Technical Writing is about scientific characterized by certain formal subjects and about elements, such as its scientific various technical and technical vocabulary, its subjects associated use of graphic aids, and its use with science. of conventional report forms. Technical Writing is ideally characterized by the maintenance of an attitude of impartiality and objectivity, by extreme care to convey information accurately and concisely, and by absence of any attempt to arouse emotion. Technical Writing is writing in which there is a relatively high concentration of certain complex and important writing techniques, in particular description of mechanisms, description of process, definition, classification, and interpretation. Source:Pexels Products of Technical Writing 1. Business Letter 6. Instructional Manuals 2. Contract 7. Brochures 3. Monograph 4. Printed Action Memo 8. Proposals 5. Graphic Aids 9. Memoranda Products of Technical Writing Business letter is a type of written communication that uses formal language and follows formal elements of letter writing. It is usually written to communicate with companies, organizations, or individuals with the purpose of applying for a job, making requests, seeking appointment, etc. Image Source: https://businessletter.org/business-letter-example-for-a-company/ Products of Technical Writing Contract is a written agreement between two people under mutually agreed terms. Definition from Merriam Webster: Contract is a binding agreement between two or more persons or parties. Contract is a business arrangement for the supply of goods or services at a fixed price. Image source: https://www.docsketch.com/contracts/ Products of Technical Writing Monograph is a detailed essay or book on a very specific topic. It is usually written by professionals or academicians on topics of interest concerning their specific fields. Image Source: https://www.sampletemplates.com/business- templates/monograph.html Products of technical writing Brochures are pamphlets or flyers that endorse a product in such a way that the potential customer will be convinced that the product is effective and eventually avail of the product. Image Source: http://stylewithtaren.com/current-avon-campaign- brochures/ Products of technical writing Proposals are written suggestions on how to make the company or organization more productive and successful. Most companies and organizations require this before an agreement is reached. Image Source: https://www.pinterest.ph/pin/745486544558571043/?nic_v2=1auZZnwbv Products of Technical Writing Memoranda are inter-office written communication used to disseminate information. Image source: https://www.pinterest.ph/pin/689402655438855574/?nic_v2=1auZZn wbv Products of technical writing Printed action memo is a ready format memorandum that only requires a checkmark on the appropriate box that contains the message. This is especially useful for busy people who need to make quick decisions and an act on the circumstance or situation. Image Source: http://www.compositionforum.com/issue/31/inventing- metagenres.php Graphic aids are drawings, sketches, and illustrations that aids the readers in understanding the presented data. Image Source: https://image.slidesharecdn.com/graphicaids2- 150925094423-lva1-app6892/95/graphic-aids-2-14-638.jpg?cb=1443174370 Products of Technical Writing Instructional manuals are written to guide the readers on how to assemble, maintain, and operate an apparatus, machine or gadget. Image Source: https://www.pinterest.ph/eliseho/instruction-manual- design/ Five Important Principles in Good Technical Writing 1. Always have in mind a specific reader, real and imaginary, when you are writing a report. Always assume that he is intelligent, but uninformed. 2. Before you start to write, always decide what the exact purpose of your report is, and make sure that every paragraph, every sentence, every word makes a clear contribution to that purpose. 3. Use language that is simple, concrete, and familiar. 4. At the beginning and end of every section of your report, check your writing according to this principle: “First you tell the reader what you’re going to tell him, then you tell him what you’ve told him.” 5. Make your report attractive. 1. It serves as basis for management decision. 2. It furnishes needed information. 3. It gives instructions. 4. It records business transactions through proposals. 5. It procures business proposals. 6. It serves as basis for public relations. 7. It provides report to stockholders. Properties of Technical Writing 1. Subject matter. In writing technical papers, you must ask the question, “What will I write about?” The subject matter is an essential element in technical report writing. Some examples of this are description of a process, writing about a theory, or submitting policy. 2. Audience. When thinking about an audience, ask “Whom am I writing for? Or who are my intended readers?” This is a property which pertains to a particular reader or a technical literature. 3. Expression. This property refers to two basic modes in which technical report has to be delivered—writing it or reading it. Your expression of the content will depend on your awareness of your audience’s/ reader’s psychology and your style in writing to be able to reach your audience’s/reader’s understanding. 4. Style. This refers to how the material is written. A technical writer uses clear, specific point of view, objective, impartial, and unemotional style in writing. 5. Arrangement of materials. This pertains to how ideas should be organized in chronological, spatial or logical order, from general to specific or specific to general, and use illustrations to present the information. Earlier, technical writing is treated as a unique form of written communication because of its important qualities, purposes and properties. Let us elucidate it further by comparing this form of writing to other writing forms. For instance, writing can be grouped into five basics types: Expressive writing is a subjective Technical writing conveys Creative writing is a fiction- response to a personal specific information about poetry, short stories, plays, experience-journals and diaries- a technical subject to a and novels-and far whereas technical writing might specific audience for a different from technical be objective observations of a specific purpose. writing. work-related experience or research. Expository writing “exposes” a topic analytically and objectively, such as reports. Persuasive writing depends on Like technical writing, the goal of expository emotional appeal. Its goal is to writing is to explain or reveal knowledge, change one’s attitude or but expository writing does not necessarily motivate him/her to action. expect a response or action from a reader. Technical Writing VS Creative Writing Technical Writing Creative Writing Content factual, straight forward imaginative, metaphoric or symbolic Audience specific general Purpose inform, instruct, persuade entertain, provoke, captivate Style formal, standard, academic informal artistic, captivate Tone objective subjective specialized Vocabulary general, evocative sequential, systematic arbitrary, artistic Organization Thank you for your participation! Please proceed to your activity. Prepared by: Ricky Basilio Reference: Rosales, M.J., Galano, E. & Rivera, J.A.(2019). Technical Writing: A resource Guide to Writing Across Disciplines. Lorimar Publishing, Inc. ISBN 978-621-8035-56-0