We’re working on our latest online training course, which is about post-writing and revising technical documentation, and we’re looking for examples of bad content we can use for the course exercises. If you know of anything we could use, please let us know by email.
Category: Technical Writing
XML isn’t the only way to semantic content
I’ve been on the road speaking at a conference this week, and I’ve been listening to a lot of presentations on technical communication. Many of these were on the importance of having structured, semantic content when you are dealing with large amounts of content that needs to be translated into different languages and published in many… Read more »
Americanisms and Britishisms
There are user documentation projects where we are asked to write in American English instead of British English, and generally this is a pretty straightforward exercise for us. However, when I speak at conferences in the USA, delegates sometimes ask me afterwards what I meant by a particular expression. For example, I was recently asked… Read more »
Microsoft launches its new documentation site, and it’s very good
Microsoft has announced the preview release of its documentation service, https://docs.microsoft.com, which currently provides content for its Enterprise Mobility products. “We interviewed and surveyed hundreds of developers and IT Pros and sifted through your website feedback over the years on UserVoice. It was clear we needed to make a change and create a modern web experience… Read more »
Perfecting collaborative authoring for online Help
Yesterday, I wrote: “There are some activities that seem like they always could be improved. One is creating an authoring environment where professional technical communicators and other staff can work together.” Writing online Help is different from writing some other types of content, in that it involves topic-based authoring. Content is stored in modular, re-usable and flexible… Read more »