Onsite Course Description

Go Back

Clear Technical Writing

Length
1 ½ days

Overview

Technical professionals and managers are often challenged to write clearly and concisely because of time constraints and topic complexities. In addition, non-standardized formats and styles can create inconsistency and confusion. Low-quality technical documentation slows development, increases errors and makes employees more reliant on one another.

This course provides a step-by-step process for designing and writing technical documents. The training involves writing, revising and editing exercises, critiquing documents and discussion.

Who Should Attend
Product managers, product developers, quality engineers

Course improves

Design documents, engineering reports, functional requirements, product manuals, test plans and reports, procedures, technical articles and white papers

  • Reduce time for participants to write technical documents
  • Increase clarity and consistency in document structure and style
  • Improve accessibility and usability of content for report audience
  • Improve efficiency in projects and product development due to quality technical documentation

Key Topics

  • Plan the purpose and scope of technical documents
  • Target content to the audience and purpose
  • Ensure completeness of content
  • Draft documents with speed
  • Begin in a way that engages the reader
  • Incorporate processes and procedures
  • Hit the right style for technical documents
  • Organize sections and paragraphs in a logical format
  • Highlight the most important information
  • Revise for clarity and brevity
  • Demystify writing using plain English
  • Eliminate jargon
  • Avoid the nine most common technical writing errors
  • Proofread for error-free writing

 

Additional topics for two-day version:

  • Achieve flow by varying sentence types and using transitions
  • Apply proper sentence mechanics
  • Craft work procedures and instructions
  • Write clear and complete summaries of meetings and reports
  • Use formatting to show emphasis
  • Revise writing by others
    Note:Two-day course includes additional writing application and a peer-review session.


Reviews

This was one of the best trainings I have had. the information was clear, relevant and I believe I can actively incorporate inoto my day. the instructor was fantastic!
– VISA DPS, Director

The entire two days were fantastic, specifically the four-step writing process, active voice section and communicating techinal information in emails.– Medtronic Diabetes, R&D Engineer


This course is available only by special request in this geography. Please give us a call today at 1-408-441-8881 or send us an email using the contact form on this site.

This course is available only by special request in this geography. Please give us a call today at 1-408-441-8881 or send us an email using the contact form on this site.

This course is available only by special request in this geography. Please give us a call today at 1-408-441-8881 or send us an email using the contact form on this site.