Designing & Writing Technical Documents – Training Course Outline

 

If your job involves writing any of these…

…this course is for you.

It concentrates on the principles and processes involved in communicating technical information effectively, whether to the layman or the expert.

What you will learn on this course

By the end of the course, you will know how to:

• Produce a documentation plan, including estimates and schedules
• Design and structure a document by analysing the readership and selecting the right information
• Write clearly and in the correct style for your readers
• Help readers find information by using appropriate ‘signposting’
• Use layout, typography and illustrations to help get your message across
• Check your own drafts
• Get the best out of writing tools and templates

What our customers say

“I enjoyed the course as a refresher, the 2-day structure is a good design for consolidating information. The trainer had a good speaking style and there were some great tools employed – e.g. Designing a document to explain to an alien how to use a spiral staircase, and the traffic light scoring card.”

SN – in4tek Ltd

“Nice and informal – paced well – good training notes and a good trainer. Has helped reinforce the work I have been doing, and given me new ideas to try.”

SW – Sage UK Ltd

“Very enjoyable course that was run at a nice steady speed with lots of opportunity to discuss the material.”

RS – Sage UK Ltd

Course Duration

We provide both a one-day intensive course and a more interactive two-day workshop.

One-day intensive

This is only available as a private course. We will tailor the course to suit your requirements by selecting modules from the course contents below or by designing bespoke modules for you.

Two-day workshop

This course is available both as a public or private course and covers all the modules described below. Over the two-day workshop, delegates practise technical writing skills, learning the techniques through group discussion, exercises and working on real examples of technical documents you bring to the workshop.

Both courses are aimed at people with some writing experience. If you're unsure which course is best for you, give us a call on 01635 202013 or 0207 0960749 for more details or email

Course Contents

1. Basic principles

• A quick overview of the documentation process
• Understanding the purpose of technical documents
• Appreciating the benefits of good documentation for your product, customers and company
• The most common technical writing mistakes

2. Planning

• Standards and guidelines – knowing where to look for guidance
• Making assumptions when the product is incomplete
• Physical presentation and its implications, eg printed or on-line
• Deciding how the documents will be developed, produced and updated
• Things to consider when estimating timescales and costs
• Preparing and maintaining schedules – synchronising documentation and development
• Writing the documentation plan – what should it include?

3. The right document for your reader

• Clarifying your purpose – how to set a clear objective
• Analysing your audience – knowing your audience; questions to ask yourself; dealing with a mixed audience
• Selecting your information – sources of data; gathering information; deciding what to include
• Organising your information so it flows – a look at the options for sequencing
• Designing your structure – techniques to help you; basic structures and alternative structures; what to include in different types of documents
• Producing a ‘skeleton’ or detailed outline – and the benefits of taking this approach
• Gaining approval – knowing the right time to do so can save you a lot of work

4. Technical writing techniques

• How to make your writing clear, unambiguous and easy to understand
• Writing for an international audience

5. Supporting content with layout and illustrations

• Choosing an appropriate layout for the type of user and how the document will be used
• Navigational aids – contents lists, indexes and ‘signposting’
• Crafting headings to guide your readers through the document
• When and where to use illustrations

6. Choosing the right writing style

• Choosing the correct writing style for different types of document
• Tutorials and installation documents – presenting concepts, instructions, lists
• Quick reference guides – what should you include?
• Comprehensive reference guides – correct order, cross-referencing
• User guides – task-oriented, indexed
• Procedures – what are the essentials?
• Functional specifications meet different needs for development, marketing, users

7. Putting it all together

• Drafting – the mindset to avoid writer’s block
• Checking your own work – how to see what’s really there, not what you think is there
• Giving and receiving constructive feedback - what makes a review effective?
• Subsequent drafts – just how many drafts should you go through? And how do you track them?
• Validation – getting it all signed off
• Preparing the ‘master’ – a checklist for peace of mind
• Updating techniques – including updating others’ documents

8. Tools to help you

• Using templates to create a consistent layout
• Getting the most out of spelling and grammar checkers
• Style guides and other sources of information to save you re-inventing the wheel
• Hiding the metadata in Word™ documents
• Handling version control of the documents

Book Now!

For details of timetabled courses, see the schedule. For prices, see the costs table.

To reserve your places you can either book on-line or call us on +44 (0)1635 202013/+44 (0)207 0960 749.