Technical Writing: Content, Structure and Organization
(One-day workshop)
Date(s):
Mar 28 | May 14 | Jun 23 | Jul 25
Instructor(s): Deborah Sauer | Neil Perlin | Kate W. Merlino
Description
This course is for people whose job requires them to write technical documentation but who have had little or no formal training in technical writing. It is also ideal for those who do some technical writing, but it is not their main job function. Participants will come away from the course with skills to help them write faster, more easily, and more effectively.
Intended Audience:
Participants must possess general writing skills and be able to use Windows-based word processing applications such as Microsoft Word.
Topics Include:
| |
- Lesson 1: Introduction
- Course Overview
- Common Problems with Technical Documents
- Types of Writing
- Lesson 2: Purpose and Audience
- Understanding Your Purpose and Audience
- Purpose
- Audience
- Understanding the Adult Learner
- Lesson 3: Designing the Document
- Introduction to Document Types
- Creating a Preliminary Outline
- Gathering Information
- Lesson 4: Developing the Content
- Procedure
- Process
- Policy/Rule/Guidelines
- Specifications
- Concept
- Description
- Lesson 5: Guidelines for Good Writing
- Choosing a Writing Style
- Creating a Sequence
- Chunking Content
- Separating the “Need to Know” from the “Nice to Know”
- Writing Effective Headings
- Applying Consistent Writing Style and Formats
- Maintaining Relevance
- Lesson 6: Putting It All Together
- Usability Testing
- Compiling the Content
|
To learn more about nSight training programs and for assistance, please contact our Training department at 781-273-6300 or Training@nSightWorks.com.
|
