How to create online Help topics that are editable by clients

In the Agile Technical Writers forum on LinkedIn, one of its members posted this question: “I need to create an contextual online help for an complex web tool (ok, that´s not that hard). The customer must be able to add some specific job instructions to this online help by himself. The customer part must not be overridden when the… Read more »

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… Read more »

The big questions in technical communication

David Farbey wrote a semi-existentialist post on the challenges for technical communicators yesterday. I’d like to look at the issue in a different way, by looking at the big questions in technical communication today. The answers to these questions (which may be decided by people outside of the profession) are likely to affect the future… Read more »

Changing times in technical communication 2 – Workflow

We’ve been on the road in recent days and weeks, visiting different documentation teams, and we’ve found there are distinct signs of change. In this post, I’ll look at how we’re starting to see the workflow for creating User Assistance beginning to change. We found many documentation teams overstretched and starting to be asked how… Read more »

The secret to user generated and crowd sourced content

Mozilla’s Janet Swisher had a number of useful tips at Technical Communications UK 2012 on how to encourage user generated and community based content: People contribute because they want to learn something and for personal growth. You need to recognise this work. Crowds aren’t smart, communities of peers are. Create a community about the topic… Read more »