Course Information

This two-day "hands on” course will focus on writing selected specific agency technical documents in an audit environment.  Participants will learn how to break down writing projects into smaller, more manageable tasks.

Upon completion of this course, participants will be able to:

•  Strengthen writing competence to reflect the State of Texas standards in all technical documents.

• Conduct audience analysis to determine appropriate language, level of detail, and format.

• Follow structured process to define document purpose, outline key points, and logically organize content for positive outcomes.

• Improve ability to collaborate with other writers on a project team.

• Edit systematically for clarity, readability, word choice, and mechanics.

• Demonstrate effective writing skills by creating or revising a complex or technical document.

Detailed Course Outline

• Setting the Stage for Writing Technical Documents

•  Define Context and Course Objectives

•  Focus on Results

• Participant Goals

• Writing Skills Survey:  Current Competency

• Technical Writing Hazards

•  Foundation for Effective Writing

•  Identify Requirements for Quality Audit Documents

• Criteria for Effective Technical Documents

• Direct Style:  SAO Guidelines

• Document Analysis

• Application: Document Review

•  Increase Competence through Correct Expression

• Grammar and Usage Diagnostic

• Core Grammar Skills

• Application:  Practice Exercises     

• Prepare Clear and Concise Audit Reports

• Strategies for Cohesive and Coherent Documents

• Guidelines for Clarity and Conciseness

• Active Voice Refresher

• Application:  Practice Exercises

• Document Readability

• Application:  Individual Document Review

•  Strengthen Electronic Communication

• Email Mastery:  Four Key Questions; Tone

• Application: Email Practice

•  The Technical Writing Process

•  Plan Report Framework

• Context and Scope

• Purpose and Objective

• Audience Analysis

• Application:  Technical Document Audience Analysis

•  Prepare Essential Components

• Core Content Assembly

• Strategies for Organizing Content

• Appropriate Sources and Attachments

• Application:  Technical Document Planning Brief

•  Write the Draft

• Key Report Elements

• Formatting for Readability

• Collaborative Writing Strategies and Proven Steps

• Application:  Technical Report Checklist

•  Review and Revise

• Edit Content and Style

• Proofread Mechanics

• Application:  Editing and Proofreading Checklist

•  Day 2:  Writing Lab

• Writing Lab:  During the afternoon of Day 2, participants plan and write or revise a workplace document.  They will edit and proofread the document as well as engage in a structured peer review.  The instructor is available to provide individual feedback and coaching.

•  Next Steps:  Ongoing Plans to Improve Technical Writing Skills

Prerequisite not required.