Convey the right technical message to your readers with these tips. And this article is aimed at helping you get better at writing technical articles. If you try to do so, quality will definitely take some hits. Some common purposes are: To convince the reader of something. She has successfully pursued contracting opportunities in Federal, state, regional and local governments in the environmental, Architect/Engineering, construction, construction management, and transportation and focuses on business development, marketing, sales, proposal preparation, capture, strategic planning and technical writing, editing and review of project deliverables. practice with your documents (commonly written by engineers - weekly reports, white papers, engineering/equipment specifications, equipment capital justifications, standard operating procedures, operating instructions, guidelines, equipment/plant outage reports, system descriptions, design criteria, inspection reports) The best way to do is to either take a break or read something else that is not connected to your work. What leaders write in particular can affect productivity and the bottom line, so the written communication that leaders create must be clear and concise. Long sentences are a big NO-NO if you want your technical content to be easily understood. In the workplace, the report is a practical working document written by engineers for clients, managers, and other engineers. Overview Board Acceptance Reviews (13) More Details. When the sentences are long, there is a great chance that sentences can become quite cumbersome to understand. It will breathe new life into the way you write and brings the best in the whole article. A structure helps you to make sure that every point to be covered is appropriately included within the content. Technical articles should not be written in passive voice unless they are specifically instructed to be structured that way. A technical article is not inherently complex. “The first is the ability to understand technical language; the second is being able to express that knowledge in a clear, concise, and coherent manner.” What is Technical Writing? Her research interests include Education, particularly Engineering Education, and Applied Linguistics. “Technical writing involves two key competencies,” indicates Atul Mathur, a professional engineer and technical copywriter in Singapore. She has successfully pursued contracting opportunities in Federal, state, regional and local governments in the environmental, Architect/Engineering, construction, construction management, and transportation and focuses on business development, marketing, sales, proposal preparation, capture, strategic planning and technical writing, editing and review of project deliverables. And to connect with engineers, the content must also speak their language. Technical content rarely needs to dwell in the past. Sometimes, it is inevitable that an engineering process or methodology is too complex and turning them into words doesn't paint the whole picture. One of the most overlooked aspects of writing is reading! At Cleveland State, for example, the engineering college now requires all of its students to take a course in technical writing in lieu of the English 2 course that had been required by the university. The most important tip of all is to never give up! One of the main forms of communication in engineering is the technical report. In the fall of 2017, the College of Engineering approved a change in wording, updating "Technical Writing Requirement" to "Engineering Communication Requirement." Therefore, a disconnection is needed between the writer and the content to make sure that the review process is carried out in the most effective way. One of the unique qualities of an engineer is adaptability. We've aimed Technical Writing One and Technical Writing Two at the following audiences: software engineers; software engineering or computer science students; Additionally, many people in engineering-adjacent roles (such as product managers) have also benefited from these courses. Course Number: PD-1003 Credit: 1 PDH Subject Matter Expert: Edward P. Brunet, Jr., P.E. A Handbook of Writing for Engineers 2nd ed. Pocket Guide to Technical Writing (Prentice Hall 1998) Eisenberg A. This is the case for every single phenomenon or mechanism out there; if you cannot explain it well, you haven't understood it well. ... technical writing; use the examples Technical writing : a practical guide for engineers and scientists by Phillip A. Laplante Call Number: T11 .L27 2012 The Naval Institute guide to naval writing by Robert Shenk This will help you to review what you wrote in a fresh mind, helping you to further enhance the content, spot mistakes, and resolve them with ease. ©2020 National Society of Professional Engineers | 1420 King St., Alexandria, VA 22314 | 888-285-NSPE (6773), A State-by-State Summary of Liability Laws Affecting the Practice of Engineering, 2019, Professional Engineer’s Role on Application of Artificial Intelligence and Technology, A-990 EJCDC Design-Bid-Build Documents, Full Set, History of the Code of Ethics for Engineers, Professional Development Partner Providers, NSPE State-by-State Summary of Continuing Education Requirements for Professional Engineers, Professional Policies and Position Statements, Virtual 2020 Professional Engineers Conference. (Macmillan 1998) van Emden J. and Easteal J. Technical Writing. Tesla Recruiting 'Ace Engineers' for Giga Berlin, Elon Musk Will Interview Candidates, Rescue Beaver Builds Doorway Dams Using Household Items. Add to Cart . Anything that keeps you on a page can be said as an engaging piece of content. If your work contains a long sentence, break them down to smaller ones. Writing can be a challenging process, but with practice, it is surely a trade that is worth mastering. When you write a technical article, peruse it from a regular reader’s viewpoint. It greatly helps to keep the content simple and easy to understand. However, when the lines are written in active voice, the content takes up an authoritative and engaging tonality. Technical Writing and Speaking, an Introduction (McGraw-Hill 1996) Pfeiffer W.S. By subscribing, you agree to our Terms of Use and Privacy Policy. It is complex when compared to the different forms of writing, and the level of complexity varies with the subject that is being discussed. Course Description: Engineers, scientists, and technology workers of all types need to produce a variety of documents such as reports, summaries, manuals, and guides. Share. Engineers are a great wealth of technical knowledge, however, they can struggle with how to prepare technical documents.