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 – 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… 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 »

Education technology – Is this also the future for Technical Authors?

(Click on the image to enlarge) Edudemic has created an infographic outlining the likely future for education. Other education sites, such as Grockit.com, suggest the future of study will have three main strands: spend some time with experts spend time on your own, and spend time with your peers If education follow this path, will… Read more »