In this page
Why attend this course?
Who is this course for?
What will I learn?
Topics covered
Delivery format
Our expertise
Price and how to book
Contact us
Master the skills of technical writing
Cherryleaf now offers a virtual classroom version of our popular Technical Author/technical writing elearning course. The virtual classroom version is for teams within organisations.
Why attend this course?
This course teaches you the key skills of technical writing for IT and software user documentation.
You’ll gain confidence you’re approaching each writing project in the right way, and creating content that follows best practice.
You’ll get immediate feedback from the trainer. You’ll discover what you’re doing right, and how you could make it even better.
You’ll have access to a framework and templates to help you with your writing. You’ll also have the opportunity to practice and review your work.
Who is this course for?
This course is ideal for graduate and junior author induction training, as well as more experienced technical writers who’ve never had any formal training.
Looking for something more advanced?
You might be interested in our Intermediate/Advanced Technical Communication training course.
What will I learn?
In this course, we’ll take you through the process of creating technical documentation. You’ll learn and practise:
- The purpose and value of technical documentation (aka having an answer if people ask why you should be doing this work).
- The entire documentation process. We’ll explain what you need to do, from beginning to end. We cover planning, writing, editing, indexing, and production.
- The skills you need as a technical communicator.
- How to work more efficiently. This framework will help you avoid wasting time.
- How to work more effectively. We’ll show you how to write and design your information in a structured, useful, usable and informed way.
Topics covered
The purpose of technical documentation
Adopting a user-centred design approach
Writing the topics
-
- Overview
- Organising the content on a page/screen
- Writing the topics
- Presenting different types of information
Using images and diagrams
- Planning and creating diagrams
- Using images
- Using screenshots
Index, Search and Metadata
Reviewing and editing your content
- Verification and validation
- Editing
- Proofreading
Software tools
Maintaining the content
Measuring if it works
Prerequisites - None
What the course does not cover
This course does not cover:
- Specific XML documentation standards, such as DITA. You can take our DITA Fundamentals course afterwards.
- API documentation, but you can take our Writing REST API Documentation course afterwards. We also offer a Technical writing for developers virtual classroom course.
- Writing User Interface text, but you can take our Writing UI Text course afterwards.
- STE or the ATA 100 regulatory documentation standard. The ATA 100 standard is used in the aerospace, military, railway, and automotive sectors.
Apart from that, this course will help you create the user assistance for your application or product.
Duration and delivery format
This course is offered as a virtual classroom course, delivered over Microsoft Teams or Zoom.
The course is split into two sessions of 3 hours each, delivered on different days.
Our expertise
As well as teaching technical communication, we also create end-user documentation, Help and UI text for clients. This means every course is based on practical experience of technical writing in today’s environment. The techniques you’ll learn on this course are the same ones used by our projects team.
Prices
The prices for the group courses depend on the number of delegates taking them. Here is some typical pricing for the virtual classroom course:
5 delegates: £1700 ex VAT
10 delegates: £2450 ex VAT
This is delivered in two three-hour sessions, usually on consecutive days, via Microsoft Teams or Zoom.