TECHNICAL WRITING SKILLS (TWS) - 2 day workshop

If you need to produce user guides, proposals, specifications or any form of online documentation then you'll be using language to communicate with your reader. This workshop covers the essential techniques necessary to produce clear and unambiguous written communications.

Using a structured process you'll start by learning how to plan your objectives, identify your audience, structure your document and select a writing style suited to your readers. Then it's time to get started – learn how to construct effective sentences and paragraphs - how to avoid bad prose - how to choose words that will connect with the reader.

Learn how editing, reviewing and testing are part of the normal writing process rather than tasks to be approached with dread. Using both individual and group exercises, you’ll have ample opportunity to practice your writing skills. You’ll also critique and re-write some of the "less than ideal" documents put out by commercial and government organisations!

This 2-day Technical Writing Skills workshop provides many practical hints, tips and rules for writing clear technical documents.

download brochure

Who will benefit?

Technical writers, business analysts and business people responsible for producing user guides, proposals, reports, specifications and online documentation.

Course objectives

Participants will learn how to produce clear, concise documents. They will be confident in the planning of an effective document that will meet the reader’s needs. They will gain the ability to constructively edit new and existing documentation.

Learning outcomes

On completion of the Technical Writing Skills workshop, delegates will be able to:

Learning techniques

Techniques used on the Technical Writings Skills workshop include:

Course Materials

Participants receive a comprehensive manual which contains copies of the course slides and can be used as an ongoing reference.

Customer testimonials

Course outline

PROBLEMS AND OPPORTUNITIES WITH USER DOCUMENTATION

Why we don't read reports and manuals - common problems with writing. What are the consequences of poor documentation? Who benefits from effective documentation? Whose responsibility is it anyway?

PREPARING THE DOCUMENT PLAN

Who will be involved? Scheduling the project. Defining the need - who is the audience? Producing "blueprints" and outlines.

MEETING THE NEEDS OF YOUR AUDIENCE

Five levels of reader, each with different needs and expectations. Reader’s, not writer's, orientation - what is the difference and why is it important? Making information accessible quickly. Selecting the appropriate media.

PRODUCING THE DOCUMENT

Format and layout. Structure – procedural, step by step, task oriented. Tradeoffs - abbreviation versus understanding. Accessibility – contents, index, glossaries, summaries.

WRITING THE DRAFT

Writer's block - two distinct causes and how to overcome them. Writing for your audience. Choosing an appropriate writing style. Passive and active voice. Conversational and narrative styles. Procedure writing - the manuscript technique. Jargon - use and abuse. Reader focused writing techniques - using examples, task orientation.

EDITING THE DOCUMENT

Six distinct editing tasks: language, style, format, context, integrity, production. Do the words make sense? The FOG index and how to measure it.

TESTING AND PUBLISHING YOUR DOCUMENT

Technical, management and audience reviews. Field testing the document for understanding. Selecting appropriate distribution methods. Production and maintenance. Maintaining a distribution list. Keeping documentation up-to-date.

SPECIFIC SKILLS

Business letters and proposals. Persuasive and motivational writing. Writing for the online reader.

Course fees & booking

Technical Writing Skills has been updated for 2008, and a number of public courses will be scheduled in the cities below. For dates, prices and to book online, visit: