HyperWrite - Consultancy and Training 

Help Systems, Structured Authoring, DITA, Hypertext, Documentation Technologies

HyperWrite Logo
Skip Navigation LinksHome > Training > Procedure Writing Training
Skip Navigation Links

Procedure Writing Techniques Training Course

The Procedure Writing Techniques training course is an intensive one-day introduction to the techniques used by technical writers. It is aimed at non-technical writers who have to document procedures, and need an understanding of the basic principles. The course covers writing techniques, and is therefore suitable for people involved in creating paper-based manuals and procedures, Help or similar Intranet or other online content. The course is one day in duration.

What You Will Learn

Upon successful completion of this course, attendees will understand the principles of technical writing, including planning and structuring procedure content. They will also have learned the basic skills of procedure writing, including identification of audience, drafting, language and style, and editing.

Pre-Requisites

There are no prerequisites for this course.

Course Content

Introduction to Procedure Writing

  • Technical Writing - What It's All About
  • How Procedure Writing Differs from Other Writing

House Style

  • Specifications and Standards
  • Purpose
  • Components
  • How House Style Controls Image
  • The Role of Style Sheets

Planning a Manual

  • Determining the Purpose and the Audience
  • The Lowest Common Denominator Concept
  • Outlining the Manual
  • Structuring Methods
  • Collecting Source Materials
  • Subject Matter Expert

Writing Procedures

  • Building from Your Manual Plans
  • William the Conqueror and Richard Coeur de Lion - How can They be Relevant?
  • Drafting
  • Wording
  • Writing Style 

Writing Techniques

  • Playscript Technique
  • Paragraph, Sentence and Word Length
  • The Role of Words in Communication

Editing and Indexing

  • The Purpose of Editing
  • Multiple Author Teams
  • Importance of Indexing
  • Indexing Techniques  

Project Control

  • Estimating
  • Budget Management
  • File Management
  • Publishing

Exercises

  • Identifying Common Deficiencies in Procedure Writing
  • House Style vs Writing Style
  • Style sheets
  • Outlining a Typical Manual
  • Communicating a Message to a Reader
  • Timing - Research, Planning and Doing
  • Failure to Communicate
  • Readability Indices
  • Meat Cleavering
  • File Naming

To enquire about this course, e-mail Tony Self, or phone HyperWrite on +61 3 9803 8291.

Valid XHTML 1.0 Transitional Valid CSS!

Your Instructor

This training course is conducted by Tony Self.

Dr Tony Self is recognised as one of the pioneers of hypertext and online documents. He has been involved in documentation and training for his entire career of 30 years. Over the past 20 of those years, Tony has worked specifically in the areas of online help systems, computer-based training, and electronic documents.

In addition to consulting, Tony is an Adjunct Teaching Fellow at Swinburne University of Technology. He is the author of The DITA Style Guide, a Fellow of the Institute of Scientific and Technical Communication UK (ISTC), and holds a PhD in semantic markup languages, a Graduate Diploma in Technical Communication, and a Graduate Certificate in Teaching and Learning in Higher Education.