Author training for software developers
This one-day technical writing course is for you if:
- You are a software developer
- You write user documentation
- You need guidance on how to write effective user guides, reference manuals, and online help systems.
You will leave the course with a comprehensive toolkit of practical skills, and a set of detailed course notes and model answers. You will be able to write documentation that is clear, consistent and concise. The result is that readers will be able to use your documentation effectively.
Course outline
The course consists of practical exercises and group discussions. The course is restricted to eight people, so there is plenty of time to discuss the individual needs of participants.
You do not need to know about documentation techniques or English grammar.
| Module | Deals with |
|---|---|
| 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. Screenshots, callouts, cropping. |
| Structuring the content | Organising the content of a document. Standard user guide structure. |
| Online documentation | Advantages and disadvantages. Basic techniques. The paper/online mix. |
| Indexing | How to create an effective index. Headings, subheadings, cross-references and locators. |
| Consolidation exercises | Putting everything together. |
| Grammar reference | Supplementary reference: grammatical terms. |
In the course itself, we focus on the areas that you want to know more about. We can work through some modules quickly, and indeed, we can omit them altogether. The material is in the course notes, so participants can review the material after the course.
If you want a course that covers other topics or that is tailored to your exact requirements, you need our bespoke author training course.
Booking information
Duration: one day.
Location: your company site or at some other location that is convenient to you. The meeting room should contain a flipchart or a whiteboard. We do not need access to computers or audio-visual equipment. If you prefer to come to us, we can arrange a suitable venue.
Fee: £795.00 + VAT for the first participant. £35 + VAT for each additional participant, up to a maximum of eight people.
Terms and conditions for on-site training.
Booking and further information: contact Mike Unwalla, 0114 266 6933 or mike@techscribe.co.uk.
Comments from participants
"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 (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 Ltd (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 Ltd.
"A thorough, professional and well-presented guide to how to construct effective technical documentation."
Peter Pond, Quality Manager, Qualsys Ltd (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 (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 (www.psydev.com).
Read press comments about the course (www.sheffieldtoday.net/ViewArticle2.aspx?SectionID=60&ArticleID=1021421).
RSS feed