Researching and preparing technical documents, especially technical specifications, calls for much effort and time. This program is designed to give you step by step guidance to writing these documents in a professional manner, working within a cost and time framework.

The program will demonstrate techniques to establishing more effective communication between technical and non-technical staff and foster skills relating to problem identification and solutions, plus enhancing skills in information seeking, research and organising collected data in a non-conflicting, unambiguous manner.

COURSE OBJECTIVES:

You will learn how to:

  • Systematically design and write accurate and comprehensive technical specifications
  • Write realistic specifications, thereby improving project management and performance
  • Write clear and concise formal reports, equipment manuals and other technical documentation
  • Develop effective communication with technical as well as non-technical staff at all levels (from top management within the organisation to the end user in the home environment)
  • Brainstorm and identify technical problems and solutions
  • Collect, organise, analyse and evaluate information
  • Transfer technical information into powerful graphs, flowcharts and tables
  • Translate technical documents into captivating oral presentations

Course Outline

MODULE 1: INTRODUCTION TO TECHNICAL WRITING

  • What is technical writing? What makes it unique?
  • Accuracy, Brevity and Clarity (ABCs of technical writing)
  • Categories of readers
  • Effective communication
  • Expressing Vs Impressing

MODULE 2: THE DEVELOPMENT PROCESS

  • Preparing to write
  • Organizing the writing
  • Editing and revision

MODULE 3: USE OF LANGUAGE AND WORDS

  • Readability
  • Clarifying the writing
  • Choice of vocabulary
  • Simplifying the writing

MODULE 4: THE ELEMENTS OF TECHNICAL WRITING

  • Technical definitions
  • Technical descriptions
  • Technical descriptions

MODULE 5: WRITING OF DIFFERENT TYPES OF TECHNICAL REPORTS

  • Formal report
  • Structure of report
  • Content
  • Conclusions
  • Appendices
  • Illustrations
  • References
  • Bibliography

MODULE 6: WRITING OF OTHER TECHNICAL DOCUMENTS

  • Technical memo and background reports
  • Technical proposal
  • User manuals and maintenance manuals
  • Journal articles

MODULE 7: OVERVIEW OF DESIGN (TECHNICAL) SPECIFICATIONS

  • Specifications and design
  • Design process
  • Understanding the problem and the development of engineering specifications

MODULE 8: TECHNICAL SPECIFICATION-PREREQUISITES TO WRITING

  • Planning to write the specification
  • Preparing the specification
  • Scope
  • Specification database
  • Basic specification information
  • Supporting information
  • Organizing input from different specialists and sources
  • Structure of technical specifications

MODULE 9: WRITING OF TECHNICAL SPECIFCATIONS - 1

  • Different types of technical specifications
  • Various uses of technical specifications
  • Creating a specification template
  • Writing the specification

MODULE 10: WRITING OF TECHNICAL SPECIFCATIONS - 2

  • Vetting the specification
  • Reviewing specifications
  • Errors in specifications
  • Specification approval and authorization
  • Hazardous materials
  • Conflicting requirements
  • Quantities
  • Professionalism
  • Do’s and don’ts of specification writing
  • Specification checklist

MODULE 11: PRESENTATION ASPECTS

  • Appearance of the document
  • Text and design
  • Visual aids
  • Most common formats of graphics
  • Illustrations
  • Highlighting techniques
  • Tips for using illustrations/graphics
  • Transferring information from notes to graphics/graphics to notes

MODULE 12: ORAL DELIVERY OF TECHNICAL PRESENTATIONS

  • What is communication?
  • Motivation and attention
  • Preparing your presentation
  • Make a positive impact
  • Using presentation aids effectively
  • Maximizing delivery impact
  • Handling difficult situations

 

Download Course Brochure