About Ellis Pratt

Ellis Pratt is Sales and Marketing Director at Cherryleaf. You can follow Ellis on Twitter. Cherryleaf helps you provide technical and user documentation your customers will love - through our content development, recruitment, consultancy and training services. See the main Cherryleaf web site for more details.

Trends in technical communication – the funny airline safety video

The airline safety video is about actions that could save your life, but it can be very dull and mundane if you’ve flown more than once. So airlines are using the third aspect in good design – emotion – to engage with their audience.

The latest video to follow this trend is from Delta Airlines:

Other examples are:

Content as an API – Google’s engineering documentation

Google’s Riona MacNamara presented at the Write The Docs North America conference on “Documentation, Disrupted: How Two Technical Writers Changed Google Engineering Culture“. In the video of the presentation below, Riona explains how she worked with a small team of writers and engineers to build a documentation platform in six months that is becoming a part of the standard Google engineering workflow.

Content as an API – Mozilla Developer Network

Mozilla is an organisation that always seems to be doing innovative things with their documentation. One of the experimental functions it has introduced to its Kuma wiki platform for the Mozilla Developer Network (MDN) documentation is an experimental PUT API that makes it possible to create and update articles remotely.

Mozilla suggests a number of ways it can be used:

You can create a page for your project and update content in certain sections from automated build, testing, and deployment scripts. This can help you keep your community up to date with your project’s progress.

If your project offers documentation alongside source code, you can push HTML renderings into a subsection of MDN. This lets you maintain docs in a way that’s appropriate for your team’s workflow, while still contributing to MDN and allowing localizers to translate the content.

Fro example, Mozilla’s programmers are able to write scripts that automatically generate articles based on contents of header files they’re creating. The API uses HTTP, which means software engineers (and other writers) effectively have the freedom to use the application environment and libraries of their own choice.

Kuma itself is an open source platform written by Mozilla in Python, using the Django framework. Contributors can fork the Kuma repository on Github, make changes to the content, and push the revised content back to the wiki.

It will be interesting to see if this succeeds, and if this type of platform extends further out than its use for developer documentation.

Institute of Directors masterclass on: The written word – creating effective content

Cherryleaf’s Ellis Pratt will be speaking at the Institute of Directors’ June 2015 Members Masterclass on “The written word – creating effective content”.

IOD building

The written word is one of the key ways we communicate with others. Whether we’re telling or selling, it’s important we get our message across. Unfortunately, many people find writing time consuming, and it can often be difficult to get started on a new document.

In this session, we’ll look at some of the most effective techniques for creating the types of content created in today’s business world. You’ll discover some of the approaches used by professional technical communicators, copywriters and report writers.

Some of the issues we’ll look at include:

  • Clarity and persuasiveness
  • Getting started and organising your thoughts
  • How to structure documents
  • Getting to the point and being concise

This session is ideal for managers, engineers and other professionals interested in effective approaches to communicating more clearly and effectively in writing.

The IoD invites IoD Members and non-members to share their expertise and knowledge with other members. It will be held at 116 Pall Mall, London, on the 2nd June (18:00 – 21:00).

See:

The written word – creating effective content.

We’ve upgraded the software that runs our shopping cart and provides access to our e-learning system

As the headline states, we’ve upgraded the software that runs our shopping cart and provides access to our e-learning courses. The main difference delegates will notice is an improved page for the links to the modules contained in a course. There are some minor improvements: how the VAT element is processed, integration with the payment gateways, and to the invoices. We think we’ve ironed out all the bugs, but if you experience any issues, do let us know.

New training courses in technical communication are on their way

It might seem like we’ve been quiet recently, but that’s partly because we’ve been working on an academic project that we hope to be announcing towards the end of the year.

As a spin-off from this project, we’re developing new training courses in technical communication. These courses are at a more advanced level than our basic/intermediate courses, and they include more references to academic research.

If you are considering any on-site training for your technical communications team, we can now offer these topics:

  1. What is technical communication?
  2. The business case for technical communication
  3. History of technical writing standards
  4. Usability and user centred design
  5. Project planning and its effect on writing documentation
  6. Researching and scoping documentation
  7. Estimating
  8. Information design and content organisation
  9. Writing the topics – overview
  10. Presenting different types of information
  11. Index, search and metadata
  12. Single sourcing and reusing content
  13. Post writing​
  14. Researching technical communication – where to go
  15. Establishing standards
  16. Governance and maintenance
  17. What skills does a technical communicator need?
  18. Content strategy and technical communication
  19. Trends in technical communication
  20. Visual design
  21. Publishing and delivering information
  22. Managing the documentation project
  23. Metrics/Evaluating documents

We may develop online courses for some of these topics in the future as well.

Presentations at Technical Communication UK Conference, Autumn 2015

Cherryleaf’s Ellis Pratt will be speaking at Technical Communication UK 2015, which will be held between 29th September and 1st October 2015, in Glasgow. Ellis will be speaking twice, about:

  • Creating an academic course in technical communication, and
  • Help in the User Interface – a case study in first user interaction and embedded Help formats.

If you’re planning to attend the conference, we look forward to see you there.

News roundup

Here’s a summary of recent activities:

  • We have a client looking to engage a technical editor for a three month contract.
  • We have a client looking for an undergraduate (or recent graduate) to spend 6 to 8 weeks as a paid technical writer intern this summer.
  • We’ve a client looking for information on applying Net Promoter Score to user assistance documentation. If you’ve seen anything, please let us know.
  • Cherryleaf’s Ellis Pratt will be the guest speaker at June’s “Member Masterclass @ The IoD”. The topic is clever content creation in business. We’ll look at some of the most effective techniques for creating the types of content created in today’s business world. The event will be held at 6pm on 2nd of June 2015, at the Institute of Directors, 116 Pall Mall, London.