Technical Writing: A Comprehensive Hands-On Introduction

Frequently Asked Questions

What is this course about? You learn to plan for and create technical documents, such as, user manuals, white papers, proposals, and reference manuals. This course provides a complete process for planning, writing and editing technical documents, including selecting document formats and making effective use of graphics. The course uses a toolkit approach from which you can select the appropriate techniques to implement in your environment. Who will benefit from this course? This course is useful for those who have to communicate information or instructions to others, or those entering the field of technical writing who need to create clear and concise high-quality manuals and white papers. While some specific document types are covered (e.g. user manuals, white papers, and proposals), the focus is on the principles of technical writing that apply in all environments. Managers responsible for planning and assessing technical writing also benefit. I have experience in technical writing. Will I benefit from this course? As an introductory course, this course assumes participants have no training in technical writing or are just starting to develop the necessary skills to excel in this field. While experienced technical writers might benefit from the review of the principles of successful technical writing, this course is intended for technical writers who are just beginning to acquire their basic skills. What background do I need? The only requirement is that you have an interest in writing well and a good grasp of the English language. Experience with Windows and Microsoft Word is helpful. Does this course cover project documentation? In relation to hardware and software projects, this course covers the creation of external deliverables -- documents used by the same people who are using the software or hardware product. Internal deliverables are created to support the development of the product; for example, project plans, requirements specifications, file layouts, design specifications and more. Internal deliverables are not covered in this course. Is this a grammar course? No. This course addresses the higher-level issues of communicating clearly and effectively. As a result, it is language independent. While this course discusses writing effectively, we assume that attendees have a basic grasp of grammar. How is technical writing different from other types of writing? Technical writing focuses on clarity, conciseness and effectiveness in delivering a message to a particular target audience. Technical writing is often performed in the context of producing a series of documents designed for a specific audience. Users typically read selected portions of a technical document as needed. Effective technical writers know how to structure information using both words and design to achieve an intended purpose. Other types of writing, primarily creative writing, tend to be concerned with mood, opinions or personality. These are typically stand-alone documents that are read from start to finish. Is this course going to be useful to me even if I'm not a technical writer? Yes! If you ever need to explain things to other people in writing this course will show you how to do it well. In this course you learn how to explain things effectively-how to get your message across so that people can do their jobs well or make good decisions based on the information that you present to them. As someone who has to produce technical documents, how will this course help me write effectively? This course focuses on a process in which you learn how to: Analyze your audience so that you can produce the documents they need in a useful format Use graphics in conjunction with your writing, as well as how to arrange your documents for maximum readability Evaluate and edit your documents to ensure that they meet your audience requirements As a manager, how will this course help me? This course defines a process and provides a toolkit for creating technical documents that will allow you to better plan and manage resources while ensuring you create high-quality external deliverables. How much time is devoted to each topic? Content Hours Introduction to technical writing 1.0 Understanding your audiences 1.5 Researching and working with subject matter experts 1.0 Implementing graphics into your document 1.5 The mechanics of writing 4.0 Writing for clarity 4.5 Creating cohesive documents 1.5 Solving common writing problems 2.0 Developing online content 2.0 Methods of explanation 1.5 Editing for quality 2.0 Times, including the workshops, are estimates; exact times may vary according to the needs of each class. What kinds of hands-on exercises are in the course? Approximately 40% of class time is spent on hands-on exercises. These exercises allow users to practice the techniques learned in the course. A variety of document types are used in the exercises so participants can experience the practical application of the tools learned in the course. Participants work in teams to analyze and define the audience. Each participant writes and rewrites several documents using various styles. Is this course applicable to a Project Management Professional (PMP) certification? Yes. Although this course is not designed as preparation for the exam, it is beneficial to anyone working toward PMI's PMP certification. For those who are currently certified, completion of this course counts as 23 professional development units (60 units must be completed every three years to maintain certification). For more details, please see the Learning Tree PMI Registered Education Provider Q&A. If you are an experienced project manager intending to take the PMP exam, you should take Course 276, Preparing for the Project Management Professional (PMP®) Exam. In this course you learn essential PMBOK® Guide - Third Edition terminology, tools and techniques. You gain practical test-taking experience through PMI-style practice exams and create your own personal study plan for continued use after the course. How does this course relate to other Learning Tree courses? This course is of interest to anyone who needs to communicate technical information in writing. This course is relevant to all Learning Tree courses that are involved in creating products that require external deliverables.

The PMI R.E.P. logo is a registered mark of the Project Management Institute, Inc.