TW NOTES.pdf
Transcript
SEEN 320 in fields such as engineering, computer L2:Understanding the Nature of Technical Writing science, healthcare, and other technical domains where precision...
SEEN 320 in fields such as engineering, computer L2:Understanding the Nature of Technical Writing science, healthcare, and other technical domains where precision and clarity are INTRODUCTION essential. The turn of the 21st century brought changes and advancements in various fields and Key Characteristics disciplines which were prompted by the rapid Clarity and Simplicity pace of technology. Technical writing breaks down complex Technology has permeated human beings’ concepts into understandable terms without lifestyles; hence, more advanced thinkers oversimplifying the content. It uses precise believe that we have to work with technology. language to avoid ambiguity. Although technology is the trend, we cannot do Audience-Specific away with traditional forms. The writing is tailored to the reader’s Even if we live in a highly technical world and knowledge level and needs. For instance, a all sectors in society including schools are technical document for experts will differ from affected by the lure to absorb modern one intended for laypeople. technology, there is still a need to preserve Objective and Factual older forms of communication. Technical writing prioritizes factual information, The effective use of technical language focusing on data, processes, and results, becomes more pronounced, especially in the without emotional or subjective input. science, information technology, and Structure and Formatting engineering and technology fields. It often follows strict formatting guidelines with Possessing skills in technical report writing is clear headings, bullet points, tables, and an advantage for people who are tasked to diagrams to organize the information logically. work on writing technical reports, manuals, brochures, and handbooks to represent their Common Types company, institution, or place of work. User Manuals and Guides Step-by-step instructions on how to operate or What is Technical Writing? troubleshoot equipment or software. Writing about scientific subjects and various Reports and Proposals technical subjects associated with the Formal documents for internal or external sciences. stakeholders, summarizing research, findings, Characterized by certain formal elements, or plans. such as its scientific and technical vocabulary, Standard Operating Procedures (SOPs) graphic aids, and conventional report forms. Detailed instructions for routine processes in Ideally characterized by the maintenance and industries like manufacturing or healthcare. attitude of impartiality and objectivity, extreme Technical Documentation care to convey information accurately and Includes software documentation, API guides, concisely, and the absence of any attempt to and system documentation aimed at arouse emotion developers and engineers. writing in which there is a relatively high Business Letter concentration of certain complex and important A type of written communication written using writing techniques, particularly description of formal language and follows formal elements mechanisms and processes, definition, of letter writing. classification, and interpretation. Contract Technical writing is a form of communication A written agreement between two people that focuses on conveying complex information under mutually agreed terms in a clear, concise, and accessible manner to a Monograph specific audience, often nonexperts or those a detailed essay or book on a very specific unfamiliar with the subject. It is primarily used topic. It is usually written by professionals or academicians on topics of interest concerning ○ Example: Instead of saying “The their specific fields. software was updated by the user,” use Printed action memo “The user updated the software.” a ready-format memorandum that only Conciseness requires a checkmark on the appropriate box In technical writing, brevity is essential. that contains a message. This is especially Unnecessary words, redundant information, useful for busy people who need to make quick and overly complex phrases detract from the decisions and act on the circumstance or effectiveness of the document. Every sentence situation. should serve a purpose and be free of Graphic aids superfluous information. drawings, sketches, and illustrations that aid ○ Example: Instead of saying “At this the readers in understanding the presented point in time,” use “Now.” data Accuracy Instructional manuals Technical writing must present information that written to guide the readers on how to is both factually correct and technically assemble, maintain, and operate an precise. Inaccurate information can lead to apparatus, machine, or gadget. costly errors, especially in fields like Brochures engineering, healthcare, or software pamphlets or flyers that endorse a product in development. such a way that the potential customer will be Accuracy also involves being specific about convinced that the product is effective and quantities, processes, or measurements. eventually avail of the product ○ Example: Instead of saying “The Proposals machine runs fast,” specify the speed written suggestions on how to make the or rate, such as “The machine operates company or organization more productive and at 500 RPM.” successful. Most companies and organizations Audience Awareness require this before an agreement is reached. Technical writing should always consider the Memoranda reader’s background, knowledge, and inter-office written communication used to expectations. Writers must adjust the disseminate information complexity of the information based on the audience's familiarity with the subject. Principles of Technical Writing For example, writing for engineers differs from The principles of technical writing provide a writing for end users, even if discussing the framework for crafting clear, accurate, and same topic. effective communication in technical fields. ○ Example: When writing an instruction These principles guide technical writers in manual for nontechnical users, avoid structuring information that meets the technical jargon and use simplified audience's needs while ensuring usability and explanations. clarity. Consistency Clarity Maintaining consistency in terminology, Clarity is the cornerstone of technical writing. formatting, and tone throughout a technical The goal is to avoid ambiguity by using document ensures cohesiveness and straightforward, concise language. readability. Writers should avoid jargon unless the Writers should establish standards for audience is familiar with the terms, and they document formatting, such as using the same should prefer active voice, simple sentence heading styles, fonts, and symbols, as well as structures, and precise word choices. standardizing terms to prevent confusion. Clarity ensures that readers can quickly ○ Example: If a procedure uses the term understand the message without confusion. “PC” in one section, don’t switch to “computer” or “machine” in subsequent It records business transactions through sections without clarification. proposals. Usability It procures business proposals. Usability is about making the document easy It serves as a basis for public relations. to navigate and understand for the intended It provides reports to stockholders of audience. companies. This involves organizing content logically, The purposes of technical writing revolve using clear headings and subheadings, and around conveying specific, often complex incorporating visuals (e.g., diagrams, charts) information in a clear and accessible manner where necessary to complement the text. to help users understand processes, solve The information should flow logically, helping problems, or make decisions. Technical writing the reader find answers quickly. is essential in industries like engineering, ○ Example: Use a table of contents and information technology, healthcare, and index for longer documents to allow business, where accuracy, clarity, and usability readers to locate specific sections are critical. easily. Document Design Purposes of Technical Writing Effective design enhances readability. Good To Inform document design uses white space, legible To Instruct fonts, bullet points, and numbered lists to To Persuade break up dense text. To Document Visual hierarchy, such as headings and To Simplify Complex Information subheadings, allows readers to scan for To Comply with Regulations relevant sections. To Enable Decision-Making ○ Example: A user manual should use numbered lists for step-by-step To Inform instructions and avoid long blocks of The primary goal of technical writing is to text. provide readers with factual and detailed information about a specific topic. Principles of Technical Wriing This includes explaining processes, describing 1. Always keep a specific reader in mind, whether functions, or offering insights into technical real or imagined, when writing a report. subjects. Assume the reader is intelligent but Examples include user manuals, technical uninformed. reports, and product specifications. Informative 2. Before writing, determine the exact purpose of technical writing helps readers understand how your report. Ensure that every paragraph, things work or how to accomplish specific sentence, and word clearly contributes to tasks. achieving that purpose.. ○ Example: A user manual for a software 3. Use language that is simple, concrete, and application informs the user how to familiar. install, configure, and use the software 4. At the beginning and end of each section, effectively. apply this principle: "First, tell the reader what To Instruct you’re going to say; then say it; finally, remind Instructional writing guides users step-by-step them that you’ve said it." through procedures or tasks, ensuring they 5. Make your report visually appealing. can complete the process correctly and efficiently. Purposes of Technical Writing The aim is to simplify complex tasks by It serves as a basis for management decision. breaking them down into manageable steps. It furnishes needed information. It gives instructions. This type of writing is commonly seen in To Comply with Regulations standard operating procedures (SOPs), In many industries, technical writing serves the instructional manuals, and training materials. purpose of ensuring compliance with ○ Example: An SOP for operating a piece regulatory requirements. of machinery provides step-by-step This includes writing documents that adhere to instructions to ensure safe and proper specific standards or guidelines set by use. governing bodies, such as safety manuals, To Persuade environmental reports, or compliance audits. Technical writing sometimes seeks to These documents must be precise, clear, and persuade readers to take specific actions or thorough to avoid legal or regulatory issues. make decisions. ○ Example: A safety manual for a This purpose is often seen in proposals, construction company ensures that all business plans, or recommendation reports, procedures comply with OSHA where the writer presents evidence, data, or regulations and can be referenced in analysis to convince the audience to adopt a audits. particular course of action. To Enable Decision-Making ○ Example: A project proposal might Technical writing often provides information outline the benefits of adopting a new that helps decision-makers evaluate options technology, aiming to persuade and choose a course of action. stakeholders to approve the project. In fields like engineering, project management, To Document and business, technical documents such as Technical writing is used to record data, feasibility studies or assessment reports processes, and results for future reference. present data, analysis, and potential outcomes This includes creating comprehensive to assist in decision-making. documentation for systems, software, or ○ Example: A feasibility report on a processes to ensure that users can access construction project provides an detailed information when needed. analysis of costs, risks, and benefits to Documentation is critical in fields like software guide investors or managers in development, engineering, and healthcare, deciding whether to proceed. where accuracy and traceability are paramount. The purposes of technical writing ○ Example: Software documentation are varied but all center around effectively details how code was written, tested, communicating complex or specialized and implemented, serving as a information to a specific audience. reference for developers who maintain Whether informing, instructing, persuading, or or enhance the software. documenting, technical writing ensures that To Simplify Complex Information essential information is accessible, actionable, One of the key purposes of technical writing is and reliable for its intended readers. to make complex information understandable The following properties of technical writing are also to a non-expert audience. This involves known as “considerations” when writing technical translating technical jargon, complex reports. processes, or specialized concepts into 1.Subject matter - What will I write about? language that a broader audience can 2.Audience - Whom am I writing for? comprehend. Writers often use visuals, 3.Expression - Should the report be written or read? diagrams, and examples to aid in this process. 4.Style - How should the report be written? ○ Example: An FAQ section for a medical 5.Arrangement of materials - How should the ideas device simplifies the technical aspects be organized? of the device's functions, enabling users with limited technical knowledge to operate it safely. Technical writing and Other Types of Writing Copyright Law Technical writing —conveys specific Copyright law protects original works of information about a technical subject to a authorship, including written texts, manuals, specific audience for a specific purpose. reports, and other technical documents. In Creative writing —is fiction (poetry, short technical writing, respecting copyright means stories, plays, and novels) and far different ensuring that any third-party content, such as from technical writing. images, charts, or text, is not copied without Expressive writing —is a subjective response permission or proper attribution. to a personal experience (e.g., journals and Copyright law grants the creator exclusive diaries) whereas technical writing might be rights to reproduce, distribute, and modify their objective observations of a work-related work, which means technical writers must be experience or research. cautious about the use of such materials. Expository writing —“exposes” a topic ○ Example: A technical writer developing analytically and objectively. Like technical a manual for a new product must either writing, the goal of expository writing is to create original diagrams or obtain explain or reveal knowledge, but expository permission to use existing ones that writing does not necessarily expect a response are copyrighted. or action from the reader. Trademark Law Persuasive writing—depends on emotional Trademark law protects brand names, logos, appeal. Its goal is to change one’s attitudes or slogans, and other identifiers that distinguish motivate them to action. products or services. In technical writing, using trademarks appropriately is critical to avoid infringement. Writers must ensure that registered trademarks are properly acknowledged, and they cannot use trademarks in a way that could mislead or imply an association with another company without permission. ○ Example If a technical writer is creating documentation for a software product that integrates with Microsoft Windows, they must acknowledge “Windows” as Relevant Laws and Ethical Considerations Related a registered trademark of Microsoft. to Technical Writing Contract Law Technical writers must be aware of legal and Contract law governs agreements between ethical considerations when preparing parties, such as between a technical writer and technical papers. a client or employer. Contracts often specify 1.Copyright Law the scope of work, deadlines, payment terms, 2.Trademark Law and intellectual property rights. 3.Contract Law In technical writing, contract law ensures that 4.Liability Law both parties adhere to agreed terms, such as Relevant Laws ownership of the final document. Technical Legal considerations like Copyright Law, writers must be clear about deliverables, Trademark Law, Contract Law, and Liability ownership, and usage rights in their contracts. Law are essential to ensure compliance and ○ Example A technical writer may sign a protect both the writer and the organization contract that stipulates the client will from legal issues. These laws govern how own the rights to the technical manual content is created, distributed, and used, upon completion, meaning the writer influencing the ethical and legal framework cannot use or distribute the document within which technical writers operate. elsewhere. and transparently, without misleading or Liability Law causing harm to the audience. Ethical Liability law addresses the legal responsibility considerations guide the technical writer to for harm caused by a product or document. In uphold integrity, respect for intellectual technical writing, especially in fields like property, and fairness in their work. healthcare or engineering, liability arises if a technical document provides incorrect L3:Traits of Technical Writing and the Writing information that leads to injury, damage, or Process financial loss. INTRODUCTION Technical writers must ensure the accuracy Technical writing is a specialized form of and completeness of their work to avoid legal communication that aims to convey complex consequences. information clearly and concisely to a specific Clear warnings, instructions, and disclaimers audience. In today's fast-paced world, where are often used to mitigate liability. information overload is common, the ability to ○ Example A technical writer for a produce effective technical documents is medical device company must ensure crucial for professionals across various fields, that the instructions for using the including engineering, IT, healthcare, and device are accurate and complete. If business (Baker, 2018). the instructions are unclear and lead to Understanding the traits that characterize misuse, the company (and potentially technical writing and the systematic writing the writer) could face liability claims. process is essential for creating documents Principles of Ethical Communication that fulfill their intended purpose. Technical writers are like researchers. Both take into consideration the bounds and Traits of Technical Writing limitations of the things they write. Clarity They carefully study the information to be Clarity is a foundational trait of technical writing presented and they are aware that prudence that ensures the intended message is easily has to be exercised. understood by the audience. It involves the DOs of Technical Communication use of straightforward language and logical Abide by relevant laws. organization to facilitate comprehension Abide by the appropriate corporate or (Graham, 2020). professional code of conduct. Writers can achieve clarity by avoiding jargon, Tell the truth. using familiar terminology, and structuring Be clear. content with headings and subheadings that Avoid discriminatory language. guide readers through the material. For Acknowledge assistance from others. instance, instead of saying "utilize," one can DONTs of Technical Communication simply say "use" to enhance clarity. False implications–assuming the outcome of To illustrate the impact of clarity, consider two a project or making sweeping generalizations excerpts from technical documents. The first, Exaggerations–expressing situations in laden with complex terminology and extreme proportions convoluted sentences, leaves the reader Euphemisms–writing about situations in confused. In contrast, a revised version that seemingly good conditions even though they employs simpler language and clearer are not sentence structuressignificantly enhances Don’t mislead your readers. understanding. Clarity not only benefits the reader but also Ethical Technical Communication reflects the writer's professionalism and Ethical communication is critically important in expertise. technical writing because it ensures that Conciseness information is presented honestly, accurately, Conciseness refers to the ability to convey factors such as the audience's familiarity with information effectively without unnecessary the subject matter and their expectations. words or elaboration (Jones, 2019). In For example, a technical report intended for a technical writing, where space and reader specialized audience may include attention are often limited, conciseness is vital. industry-specific jargon, while a document Writers should aim to eliminate redundancy, aimed at a general audience should avoid avoid filler words, and focus on delivering such terminology. essential information. For example, instead of By recognizing the audience, writers can saying "due to the fact that, " one can simply create documents that resonate with readers use "because." and fulfill their informational needs. To demonstrate the significance of Accuracy conciseness, consider a case study where a Accuracy in technical writing is paramount, as technical manual is criticized for its length and it ensures that information is correct and verbosity. reliable (Johnson, 2023). By revising the content to be more concise, the Writers must conduct thorough research, document becomes more user-friendly, fact-check their claims, and seek peer reviews allowing readers to find the information they to validate their content. need quickly. Inaccurate information can lead to Conciseness not only improves readability but misunderstandings, safety hazards, or legal also enhances the overall effectiveness of the issues, highlighting the critical importance of document. accuracy in technical documents. Accessibility Consider a case where a technical manual Accessibility in technical writing involves contained incorrect specifications for making documents usable for a diverse machinery, resulting in operational failures. By audience, including those with disabilities implementing rigorous accuracy checks and (Kirkpatrick, 2022). It requires consideration of peer reviews, the organization can prevent various formats, such as text, graphics, and such costly mistakes and uphold its reputation. multimedia, to cater to different learning styles Consider a case where a technical manual and needs. contained incorrect specifications for Techniques for enhancing accessibility include machinery, resulting in operational failures. By using alt text for images, providing captions for implementing rigorous accuracy checks and videos, and employing a clear layout that aids peer reviews, the organization can prevent navigation. such costly mistakes and uphold its reputation. For instance, a user manual that incorporates Stages of Writing Process visual aids and diagrams is more accessible Pre-WritingStage than one that relies solely on text. The pre-writing stage is essential for effective Accessible documents not only comply with technical writing, as it lays the foundation for legal standards but also ensure that the entire writing process (Simmons, 2019). information is available to all users, thereby During this phase, writers engage in fostering inclusivity and equity. brainstorming, outlining, and research to Audience recognition gather relevant information and organize their Audience recognition is the ability to identify thoughts. and understand the target audience's needs, Effective pre-writing helps identify key topics, preferences, and knowledge levels (Richards, subtopics, and the overall structure of the 2021). This trait is critical in shaping the document. content, tone, and style of technical Writers should also consider their audience documents. during prewriting, ensuring that their approach Writers must conduct audience analysis to aligns with the audience's needs and tailor their message effectively, considering expectations. A well-thought-out pre-writing phase can save DOs and DON’Ts of Writing the First Draft time and effort in the subsequent stages of 1. Don’t overanalyze your writing. writing and revising. 2. Do feel free to follow the flow of ideas where In this stage, the writer composes or supplies they lead you, even if it is not what you initially information pertaining to: planned. ○ Purpose of the paper—This is 3. Don’t exaggerate details. necessary to determine the content, 4. Do work on the details as much as possible to organization, and style of the paper. keep the story fresh in your mind. ○ Choice of topic—A writer has to explain 5. Don’t worry yet about how good your writing is. or justify their chosen topic. 6. Do have fun! ○ Gathering information—A writer must Re-WritingStage find sources of information to enrich Re-writing is a crucial step in the writing their topic. process, allowing writers to refine their drafts Pre-Writing Techniques and enhance the overall quality of the 1. Keep a writer’s journal by recording personal document (Anderson, 2022). This phase experiences, perceptions, and ideas. involves revising for clarity, conciseness, 2. Do free writing. Write about whatever comes to accessibility, and accuracy. mind. Writers should also check for grammatical 3. Brainstorm by listing ideas as quickly as they errors, formatting issues, and inconsistencies. occur. Multiple drafts are often necessary to achieve 4. Cluster by drawing lines and circles to show a polished final product. Seeking feedback connections between ideas. It is also called from colleagues and engaging in self-editing webbing or making connections. are vital practices that contribute to effective 5. Ask questions using the news reporter’s re-writing. 5Ws—Who? What? Where? Why? When? We revise to ensure that: How? ○ the content of the paper is relevant 6. Read with focus. This entails reading efficiently ○ there is organization and coherence in to locate specific information. the arrangement of ideas 7. Listen with focus. This means listening ○ grammar and mechanics are clearly efficiently to locate and collect specific observed information. 8. Observe by noticing details around you CONCLUSION through the senses. Mastering the traits of technical writing and the 9. Imagine. Probe your imagination for ideas, and writing process is vital for producing effective often use a “what if?” approach. documents. By focusing on clarity, Writing Stage conciseness, accessibility, audience The writing phase involves transforming the recognition, and accuracy, writers can create pre-writing ideas into a coherent draft (Taylor, content that meets the needs of their readers. 2020). During this stage, writers should focus Furthermore, a systematic writing on producing content that reflects the traits of process—encompassing pre-writing, writing, technical writing discussed earlier. and re-writing—ensures that technical It is important to maintain clarity, conciseness, documents are well-organized, polished, and accessibility, audience recognition, and effective. accuracy while drafting. In addition, writers should seek feedback from peers or mentors during this stage to enhance the quality of their work. Constructive criticism can identify areas for improvement and lead to a more polished final product.
