Technical and Report Writing

technicalThe ability to write clear, concise documents related to technical issues is a highly desirable skill that is much different from writing letters, emails, and non-technical documents.  The creation of effective technical materials requires discipline, organization, and a keen eye for detail.  This course is designed to give good writers or technical staff who posses decent writing skills the tools needed to design, develop, and maintain technical documents.

Duration:

3 days

Prerequisites:

Students should bring at least five writing samples of varying lengths, content, and purpose.  These may be their own or from some else.  The author’s identification may be blocked.  During this course, these are reviewed and rewritten.

Objectives:

  • Upon completion of this course the attendee will learn:
  • Focus on putting complex subjects in terms that are clear and concise
  • Enables development of a writing style that’s more useful to readers
  • Learn an approach to writing reports that’s fast and easy
  • ]How to write reports that maximize impact on your readers
  • ]To write so others apply your ideas
  • Command of language and grammar
  • Organizational skills and attention to detail
  • Recognize and carry out various strategies of technical writing
  • Enhance documents with visuals and graphics

Content:

Day 1:

  • Understand the general format of reports- Categories
  • Brainstorm and organize information – feasibility studies – abstract
  • Apply mechanics of writing – usage – capitalization – punctuation
  • Active/Passive Voice
  • Avoid wordiness and pompous language
  • Introduce variety in sentences – graphics and visual aids
  • International Guideline Variations
  • Write for the reader
  • Write executive summaries

Day 2:

  • Describe responsible research
  • Avoid plagiarism and Distortion of Tests and Research Results
  • Describe ethical implications of Research & Development
  • Use effective laboratory research Reports
  • Write persuasive evaluation reports
  • Write definition assessments-describing mechanisms-essays-surveys
  • Use Tables, graphs and charts effectively
  • Format documents effectively
  • Use numeric information
  • Copyright Considerations

Day 3:

  • Use of Visual Enhancements
  • Apply U.S. Military Writing Guidelines
  • Understand Ethical Implications
  • Write Abstracts
  • Calculate the Fog Index
  • Comply with approved styles guides
  • Engage in review of participant's writing with constructive critique