Technical Writing Skills Tip of the Month – March

Home / News, Views & Updates / Technical Writing Skills Tip of the Month – March

Technical Writing Skills Tip of the Month – March

The Description

The majority of technical reports include some type of description, either of objects, processes or ideas. A description can be physical, functional or both. Good descriptions are crucial to creating good documents and they should utilise the Outside-In approach, a technique discussed in our previous blog (February 2017)

  • Always keep in mind the technical level of the intended reader.
  • Begin with the name of the object, followed by its definition.

e.g.  A mobile phone is a handheld communication device.

  • Include a labelled diagram or photograph to aid understanding.
  • Describe the most obvious features first and then proceed to specific details.
  • Provide examples of what you are explaining.

and remember; always use the Outside-In approach.

To find out more about this and other practical tips that will improve your technical writing why not come along to one of our Technical Writing Skills training courses. To enquire further or to book, call us on +353 61 339040 or email us.

John Lafferty – Technical Writing Tutor 

John Lafferty is our Technical Writing Skills course Tutor. John also delivers courses in areas such as Quality Systems, Process Validation, Software Validation and Quality Risk Management on behalf of SQT. John runs a Quality Management Consultancy, Northridge Quality & Validation, which specialises in providing assistance to the Medical Devices and Pharmaceutical sector.

Related Programmes

Share this Article

Blog Sign up

Sign up to receive the latest industry and company news direct to your inbox.