It’s not quite 2018 yet, but here are our predictions for technical communication in 2018 and beyond. We also look back at the predictions we made for 2017.
Our next policies and procedures writing training course will be on 31st January 2018.
Cherryleaf’s policies and procedures course teaches your staff how to write clear and effective policies and procedures, in a straightforward and efficient way.
It is popular with staff from charities, housing associations, and the NHS, although it will benefit many writers of policies and procedures.
In this episode of the Cherryleaf Podcast, we look at the tools used by technical communicators for editing and reviewing content.
Did we miss any out?
We look at the pros and cons of using the DITA standard, and the alternatives.
This October, Cherryleaf celebrates 15 years in the technical authoring business.
Over the years we have had many exciting challenges and worked with some wonderful inspirational people: none more so than our friend and co-founder, Carol Johnston, who sadly died of a brain tumour in 2012. Carol was enormously talented: a brilliant pianist and singer, a Cambridge Maths graduate and an excellent author. She contributed so much to Cherryleaf, and we miss her as much for her sense of humour as for her problem-solving abilities.
To celebrate Carol’s life and contribution to Cherryleaf, as well as our 15 years in business we have created the Carol Johnston Memorial Award. Carol was a great teacher and trainer – knowledgeable, professional and patient. She trained many authors over the years and would be, we hope, very pleased to continue contributing to the technical authoring world through the Carol Johnston Memorial.
The Carol Johnston Memorial Award is the chance for two young European Technical Authors (or erstwhile Technical Authors) under the age of 30 and living in Europe to access all Cherryleaf’s online courses free for 12 months. These courses include: our ISTC accredited training course which teaches the fundamentals of being a tech author; our Advanced technical writing course, and our WriteLessons courses.
To apply, all you have to do is send us a brief statement explaining why you want to have access to the Carol Johnston Memorial Award courses. We’ll draw two winners in December.
Back in July, we looked at creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare) .
We done some further testing. We’ve created two new examples for API documentation that had been generated with the Stripe API look and feel and imported into Flare:
- Example A – Replacing the standard left hand Table of Contents with Flare’s local TOC on the right hand side.
- Example B – Removing the standard left-hand Table of Contents, so the descriptions and code samples can use the full width of the topic.
To compare the two, here is the standard “Stripe API” left-hand Table of Contents when imported into Flare.
We’ve not made any changes to the default Heading styles from the source files. The stylesheets would needed to be modified to make them consistent with the styles used on the other HTML pages in the project.