Technical Writing and Editing

As a technical communicator, your ultimate goal is to produce the most effective and usable documentation for your audience. To achieve your goal, you’ll need to understand how to structure and organize user-centric technical documentation using standard components and how to write well, using plain and concise language. No one writes a perfect first draft, so you’ll also learn how to edit technical documentation, and how to use a style guide to facilitate consistency.

Through reading, discussions and homework, you will create a how-to manual, practising techniques for creating concise and functional documentation that will work well in print or online. Throughout the course, you will complete assignments, contribute to class forum discussions and edit a classmate’s project while yours is being edited.

What  You’ll Learn

• Describe what technical writers do and what skills they need.
• Define types of technical documentation.
• Identify document parts and elements and how to use them to structure your document for clarity and flow.
• Describe and practice using the tools of the trade, such as style guides and templates.
• Write clear and concise online and print documents.
• Describe the different types of edits and style guides, practice editing and create your own personal editing style guide.