Module 1 Technical Writing (PDF)

MODULE ONE NATURE OF TECHNICAL WRITING RYAN ELBERT Z. GAN CITY COLLEGE OF ANGELES LEARNING OBJECTIVES A. Identify the meaning and nature of technical writing. B. Describe the different characteristics of technical writing. C. Distinguish the p...

MODULE ONE NATURE OF TECHNICAL WRITING RYAN ELBERT Z. GAN CITY COLLEGE OF ANGELES LEARNING OBJECTIVES A. Identify the meaning and nature of technical writing. B. Describe the different characteristics of technical writing. C. Distinguish the principles & significance of technical writing. D. Distinguish the role of technical writing in the field of specialization. INTRODUCTION TECHNICAL WRITING DEFINED TECHNICAL WRITING DEFINED TECHNICAL WRITING DEFINED TECHNICAL WRITING IS… the type of everyday writing that surrounds us: directions on the mouthwash bottle, nutrition benefits on the cereal box, business letters and catalogs that come in the mail, written instructions for assembling a new product, receipts, product safety information. DEFINITION Technical Writing is objective, clear and accurate, concise, and unemotional in its presentation of facts. DEFINITION Technical Writing is communication whose primary aim is to convey a particular piece of information for a particular purpose to a particular reader or group of readers. DEFINITION Technical Writing is the process of transforming and translating technical information into a written output that a target audience will understand. TECHNICAL WRITING DEFINED Technical Writing is business writing, workplace writing, professional writing, or informational writing TECHNICAL WRITING DEFINED Technical writing is required in all professions and critical in the workplace.  REVIEW: Give THREE (3) DEFINITIONS OF TECHNICAL WRITING. COMPONENTS OF TECHNICAL WRITING COMPONENTS Context Message Language Purpose Audience Product CONTEXT the situation in which technical writing exists may include the personal relationships with the intended audience, time and place, and interferences that may influence the writing MESSAGE refers to the content Includes facts, issues, and relevant details for clear and effective communication LANGUAGE the channel used to convey the message it may be formal or informal; however, in the context of technical writing, language is usually formal and standard PURPOSE the reason why the technical writer is communicating, including the motives and reaction s/he wants to elicit from the target audience purpose is two-pronged: to inform and to persuade AUDIENCE the receiver of the information; to understand the audience, you need to know their purpose, desires, motivations, attitude, and level of understanding about the subject may be classified as primary (addressee of the letter) or secondary (the cc in the letter) PRODUCT the physical form of the message influenced by context, purpose, message, language, and audience may include letters, memos, reports, proposals, abstracts and summaries, and resumes REVIEW: Discuss HOW EACH COMPONENT INTERACTs WITH EACH OTHER TO FORM INTO A WHOLE CHARACTERISTICS OF TECHNICAL WRITING SUBJECT the content of technical writing is objective information that is accurately and clearly presented: it tells the reader exactly what to do, how to do it, and under what conditions to do it it presents factual data, statistics, and measurable elements in all formal aspects of professional areas SUBJECT Technical Writing: specific knowledge that is analyzed logically and evaluated scientifically Creative Writing: leaves a powerful feeling or emotion (there are different interpretations that are possible depending on the readers) AUDIENCE In technical writing, the needs of the reader dictate every decision the writer makes. Readers may be specific individuals or a general group with common interests: but both groups are reading for particular purposes STYLE Style refers to the way an author uses words and sentences. Technical documents use a simple, concise, straightforward style that is easily understood Sentences are short and the use of jargon (highly-specialized language of a particular discipline) is present TONE Tone refers to emotional overtones– the way words make a person feel. It describes the emotional character of a document The tone of technical writing is best described as objective or businesslike as readers read for information, not for entertainment. Some may say it is boring, but for the targeted audience the topic is not. SPECIAL FEATURES Special features of a technical document may include the use of boldface, italics, capitalization, columns, lists and others to draw the reader’s attention to certain information Graphics such as tables, graphs, pictures, and diagrams also help the audience grasp complex information quickly TYPES OF TECHNICAL WRITING TECHNICAL WRITING IS AMONG the most widely-read written communication, likely surpassed only by advertising and some popular literature. CLASSIFICATION BUSINESS explain rules, regulations, business plans SCIENCE explain theories, hypotheses, experiments CLASSIFICATION MEDICAL explain instructions of software and hardware in hospitals ENGINEERING instructions on how to build machines or use tools CLASSIFICATION LEGAL all legal documents and the fine print in contracts such as agreements, affidavits, trademarks, copyright TECHNICAL DOCUMENTS End-User Assistance Documents help a user understand a software or hardware product user manuals for computer programs, household products, medical equipment, mobile phones, and other consumer products TECHNICAL DOCUMENTS Traditional Technical Documentation communicates to a specialized audience maintenance guides, repair manuals, research paper, annual reports, engineering specifications TECHNICAL DOCUMENTS Marketing Communication product catalogs, brochures, advertisements, introductory pages for websites, press releases  Action Plans Description Advertisement Diagram, Chart, or Graph Agenda Editorial Audit Report Email Book Review Feasibility Report Brochure Field Test Report Budget Incident Report Business Letter Informational Form Business Plan Informational Poster Catalog Informative Summary Contract Instructions Critique Interview Questions Data Book or Display Itinerary  Job Application Product Comparison Job Description Proposal Lesson Plan Questionnaire Letter of Inquiry Research Report Letter of Recommendation Résumé/Portfolio Magazine/Newspaper Article Scientific Paper/Report Marketing Plan Survey Memo Test Meeting Minutes Transcription Newsletter Training Manual Observation Report Travel Guide Performance Evaluations Web Page Persuasive Proposal Work Order Position Paper  REVIEW: Enumerate the different characteristics of technical writing. Give the classifications of technical writing. SIGNIFICANCE OF TECHNICAL WRITING THE GOAL OF TECHNICAL WRITING is to enable readers to use a technology or understand a process or concept. PURPOSE It gives information that leads to the accomplishment of specific tasks and in the making of needed decisions Example: what to do during an earthquake, how to use safety devices, how to operate new equipment PURPOSE It analyzes events and their implications, the failure of certain systems and the needed changes Example: how to save the dying rivers of the country PURPOSE It persuades and influences decisions by showing how a business or an industry succeeds Example: improvement of the educational system, improvement of the energy situation in the country LESSON QUIZZES MODULE ONE: NATURE OF TECHNICAL WRITING  LESSON QUIZ Write: A if only the first statement is correct; B if only the second statement is correct; C if both statements are correct; and D if both statements are incorrect.  LESSON QUIZ 1. a. Technical writing surrounds us everyday. b. An example of technical writing are news articles. 2. a. Technical Writing is required only in some professions. b. Technical Writing holds little significance in workplaces. 3. a. Technical Writing is aims to share information to a specific reader or group of readers. b. In doing so, jargons may be used in technical documents.  LESSON QUIZ 4. a. Personal experiences and literary devices may be used to make technical documents more effective and realistic. b. One can also narrate different tales of characters and use strong emotions to get the message across. 5. a. In presenting facts, technical documents should be objective, clear, accurate, concise, and unemotional. b. Other names of technical writing include professional writing, academic writing, and business writing.  LESSON QUIZ Components of Technical Writing A. Audience B. Context C. Language D. Message E. Product F. Purpose 1. This refers to the physical form of the message. 2. This refers to the content of the technical document. 3. This refers to the channel used to convey the message.  LESSON QUIZ Components of Technical Writing. A. Audience B. Context C. Language D. Message E. Product F. Purpose 4. This refers to the situation in which technical writing exists. 5. This refers to the receiver of the info, the readers. 6. This refers to the reason why technical documents are written.  LESSON QUIZ Characteristics of Technical Writing A. Audience B. Special Features C. Style D. Subject E. Tone 7. This refers to the way an author uses words and sentences. 8. This is the way words make a personal feel. In technical writing, it should be objective and businesslike. 9. This may include typography and graphics to help readers understand the information quickly.  LESSON QUIZ Characteristics of Technical Writing A. Audience B. Special Features C. Style D. Subject E. Tone 10. In technical writing, this dictates the decision that the writer makes in writing the document. 11. This states that only objective information should be presented in the documents.  LESSON QUIZ A. End-user B. Marketing C. Traditional 12. This is written to communicate to a specialized audience. 13. This helps readers understand how a product should be used. 14. This aims to convince readers why they should purchase or subscribe to a particular product or service.  LESSON QUIZ 15. People read literature for pleasure; essays for enlightenment; and journalism for news. People read technical writing to ____________________________________________________.  RESOURCES Barrot, Jessie S. (2015). Technical writer’s survival kit: A guide to effective technical writing. Quezon City: C&E Publishing Inc. Smith-Worthington, Darlene. (2013). Technical writing for success. Pasig City: Cengage Learning Asia Pte Ltd Alcantara, Rebecca D. (1995). Technical writing for Filipinos. Quezon City: Katha Publishing Co., Inc. Technical Writing for Filipino Students Retrieved from https://books.google.com.ph/books/about/Technical_Writing_for_Filipno_Students.html?hl=tl&id=jD 4h6QiYo40C&redir_esc=y