Technical author training for software developers

If you need to write effective user guides, reference manuals, and online help, this technical author training course is for you.

At the end of the training course, you will have a new set of practical skills, detailed course notes, and model answers. You will be able to write clear documentation. The result is that your customers will be able to use your documentation effectively.

Training course content

The training course contains practical exercises and group discussions. A maximum of eight people can attend the training course. Therefore, there is more than sufficient time to discuss the needs of all participants.

You do not need to know about documentation methods or English grammar.

Modules in the technical author training course
Module	Is about
Introduction	What is documentation? Typical problems with low-quality documentation.
Writing in plain English	Principles of clear writing. Avoiding jargon.
Common 'gotchas'	Apostrophes, subject-verb agreement.
Tenses	The recommended tenses used for technical writing.
Active voice and passive voice	What they are. When to use them. Converting one to the other.
Using language precisely	Typical causes of ambiguity in text. Problem words. Commas.
Lists and tables	Bulleted lists, numbered lists, run-in lists. When to use them. Guidelines for effective tables.
Audience analysis and task analysis	Reasons for understanding the needs of readers. Defining tasks. Deciding on the level of detail.
Procedures	Descriptions, processes, and procedures compared. Headings, steps, and conditions in procedures. Notes, cautions, and warnings in procedures.
Visual style and layout	Visual cues to help readers.
Graphics	How to use graphics effectively. Screen shots, callouts, cropping.
Structuring the content	Organising the content of a document. Standard user guide structure.
Online documentation	Advantages and disadvantages. Basic techniques. The printed/online mix.
Indexing	How to create an index. Headings, subheadings, cross-references and locators.
Consolidation exercises	Putting everything together.
Grammar reference	Supplementary reference: grammatical terms.

If you want a training course that covers other topics or that is customised to your requirements, you need our customised technical author training course.

Booking information

You choose the day, and we deliver the technical author training at your company site or at some other location that is convenient to you. The meeting room must contain either a flipchart or a whiteboard. We do not need computers or audio-visual equipment.

Fee: £795.00 + VAT for the first participant. £45 + VAT for each additional participant, up to a maximum of eight people.

Terms and conditions for on-site training.

To book a place, or to get more information, contact Mike Unwalla, 0114 266 6933 or mike@techscribe.co.uk.

Comments from participants

Participants on a training course

"Useful and insightful, delivered in a professional yet clear & concise manner."

Adam Leggott, Web Administrator & Developer, Roeville Computer Systems (www.roeville.com), Doncaster.

"Many thanks for a well thought out & helpful course."

Colin Gilchrist, Lead Web Developer, Digital Fibre Limited (www.digitalfibre.co.uk), Tring.

"Thank you for coming all this way to give your workshop. We all thoroughly enjoyed it and I've received a very positive and enthusiastic response from everyone. It certainly triggered many discussions!"

Ceri Lloyd, Senior Software Engineer, Energy Scitech Ltd (www.enscitech.com), Guildford.

"The day Mike spent with Tamblin was excellent. Not only did we learn a lot, it was also genuinely interesting and enjoyable. This was achieved through a combination of quality course notes, practical exercises, Mike's in-depth knowledge and his flexible approach to the day. I can heartily recommend the TechScribe training days to anyone looking to improve upon their technical writing skills."

Stuart Turner, Production Director, Tamblin Limited, London (www.tamblin.com).

"After spending the day with Mike I feel much more confident about approaching the writing of technical documentation. Excellent value. I would recommend this course to all software developers."

Nathan Briggs, Website Developer, Sheffield Web Solutions Limited, Sheffield.

"A thorough, professional and well-presented guide to how to construct effective technical documentation."

Peter Pond, Quality Manager, Qualsys Limited, Sheffield (www.qualsys.co.uk).

"Superb course materials. The training course led by Mike provided an invaluable comprehensive overview of a potentially dry and daunting subject in a fast-paced and highly enjoyable format. Thank you very much!"

Dr Simon Zipperlen, Technical Director, Estona Internet Marketing Ltd, Sheffield (www.estona.co.uk).

"Mike Unwalla is an expert in his field and the quality of his training reflects this. A vital asset to any software house."

Phil Nicholls, Director, Psydev Ltd, Sheffield (www.psydev.com).