TECHNICAL WRITING

How to write about complex information in simple ways – a 2-day in-house training programme

Course detail
icon_koha

Who?

Who?

  • anyone working in a specialist field who wants to write clearly
  • technical people writing for non-technical people
icon_pono

How long?

How long?

2 days

(9am – 4:30pm)

icon_ahurutanga

How many?

How many?

Up to 12 participants

 Course description

Don’t be misled: “technical” doesn’t necessarily mean you’re a scientist or an IT guy. Technical writing is about transmitting the specialised knowledge from your field to anyone else — non-specialists, in other words.  Or, maybe you’re providing that information to other specialists who are busy and need you to give them quick updates, summaries, or new processes to follow.

This course provides you with tools to write about complex information in simple, clear, unambiguous (and maybe even engaging) ways!

Technical writing is for people in finance, IT, Health & Safety, insurance, medicine, aviation, and engineering.   And if you’re reading this, it’s probably for you.

Course content

  • plain language approaches — how to make your writing clear, simple, and understandable by a wide audience
  • reader-centric tools — understanding your readers’ needs, and structuring a document accordingly
  • editing and reviewing techniques — so you can make sure documents (written by you and others) are sharp, polished, and impressive every time!
  • the requirements of technical writing
  • planning tools — how to separate thinking from the writing so you use your time most efficiently
  • fit for purpose structure and tone — understanding the principles to make every technical document work for its context
  • formatting technical documents for reader ease
  • supported writing, using your own documents

Course outline day 1

  • what is plain language?
  • who uses it?
  • why use it? (the benefits)

  • active voice
  • 1st person
  • speakable Language
  • sentence length
  • positive
  • professional
  • personal

  • focus on the reader for success
  • putting yourself in the readers’ shoes
  • what all readers want to know
  • bottom line up front

  • what is technical writing?
  • industry trends
  • the technical writing toolkit
  • presenting information visually
  • consistency, conventions, and industry standards
  • separating thinking and writing (so you can use your writing time more efficiently)
  • identifying audience
  • prioritising the needs of multiple readers

Course outline day 2

  • identifying the overarching purpose
  • planning to achieve the purpose
  • reader-centric structures
  • identifying and achieving the right tone for the audience and purpose

  • what readers want
  • the psychology of the visual
  • from mundane to insane(-ly easy to read!)
  • how to engage the reader
  • which are the best fonts?
  • how layout affects message reception

Practice, practice, practice!

  • 3 hat editing process
  • reviewing skills
  • surviving the review process
  • practice, practice, practice!

Other info

icon_koha

Before the course

Before the course

  • provide samples of your business writing
icon_pono

To bring on the day

To bring on the day

  • laptop/tablet (optional but useful)
  • your own documents to work on
icon_ahurutanga

Post-training options

Post-training options

  • 1 – 1 coaching
  • document assessments

What are you waiting for?

Talk to Shelly

Wanna sell this program in your business?

Download this info

“Some people suffer concurrently from two medical conditions – a diarrhoea of words and a constipation of ideas”—1936 yearbook of the University of the Philippines