Writing Technical Documentation

loading..

loading..
or GET IT WITH SATVs

This two-day workshop introduces attendees to the process of writing good quality technical documents. Technical documents include procedures, instructions, manuals, and user guides. You learn to clearly define outcomes of what your writing must deliver, who your readers are, and how to present the information in the most useable way. This course will give you the tips and techniques so that all your documents are clear, concise and consistent. You systematically work through the planning, structuring, writing, checking and presentation stages of a project so that you finish with a high quality piece of writing that reaches its audience and achieves its purpose.

  • What technical writing is
  • Why we need technical writing
  • How you can use Plain English in technical writing
  • How you can use the 5 step technical writing process

  • Establishing a document aim
  • Creating into a workable outline
  • Keeping track of your writing style

  • Basic grammar terminology
  • Writing sentences with impact
  • Using paragraphs as an organisational tool
  • Differentiating between active and passive voice and recognise prepositions
  • Creating lists
  • Using punctuation, capitals and tense consistently

  • Choosing concise and explicit words
  • Dealing with jargon, technical words, acronyms and abbreviations
  • Writing positively and differentiate between Australian, US, and UK English
  • Using inclusive language and analogies

  • Creating effective charts
  • Creating effective screen shots
  • Creating effective diagrams
  • Creating effective tables
  • Outlining procedures with flow charts
  • Representing hierarchies with organisational charts

  • Checking the document technically
  • Checking the document for readability

  • Checking the document yourself
  • Using your editor
  • How to test the draft for readability
  • Finding out whether it works for your audience
  • Self checking and editing the document
  • Checking for accuracy and flow

If you are responsible for writing or editing technical material such as user manuals, staff instructions, procedures manuals, reference materials or training manuals this workshop is ideal for you. This course is especially designed for:
  • Technical writers
  • Training specialists
  • Business and systems analysts
  • Information technology managers
  • Security and safety professionals
  • Publications managers
  • Researchers
  • Quality managers
  • Project managers

Key Business Benefits

  • Presents a better business image to customers through clarity and pithiness
  • Boosts an individual’s productivity through following a time saving process
  • Saves the time of others by easier readership and understanding
  • Mitigates risk through increased understanding and reduced ambiguity

Key Participants Benefit

  • Adapts to audience needs by simplifying complexity
  • Creates a professional individual image through well constructed and professional prose
  • Allows individuals to accomplish greater productivity in writing through planning
  • Aids confidence in writing through an easy to follow process
Participants will leave the course with a certificate of attendance and an individualised action plan to help support next steps on return to the workplace. More importantly you will have developed skills and knowledge to:
  • Plan a technical document
  • Write appropriately for the audience
  • Understand basic grammar
  • Write clearly
  • Test a technical document
  • Edit a technical document

Register

In Class

    Show all

    In Class

      Show all

      In Class

        Show all

        In Class

          Show all

          OnlineLive

            Show all

            Connected Classroom

              Show all

              Not currently scheduled

              Fast track the availability of this course.
              Add to watch list or call 1300 794 006.

              Need your team upskilled?
              Request a Quote
              blah is false
              top