Technical authors, documents and getting lost

Via Twitter, someone responded to one of my messages with the statement, “maybe, if you need a manual, it’s a poor product”. I don’t think that’s the case, and my reply on Twitter was: “A map is to a city, what a manual is to an application.” Let me explain. Imagine you need to visit… Read more »

“The worst Help system I have ever seen”

Sarah Maddox reported from the WritersUA conference that Microsoft’s April Reagan gave a frank presentation on the planning and design that has gone into version 3 of Microsoft Help. She was quoted as saying the feedback on the Help 2 (used in Windows Vista) was poor. For example, “This is the worst help system I have ever seen”.  At a previous… Read more »

Manager’s guide to single sourcing: What’s the problem, why is there a need?

I thought it might be useful to look at a simple question: Why is there a need for single sourcing technical documentation? For people who aren’t technical authors, it’s often unclear why technical authors talk so much about “single sourcing”. Isn’t that just cutting and pasting? What’s the problem? In later posts we’ll look at the… Read more »

Cherryleaf’s article in “Communicator” – Benchmarks for High Performance

Copies of the Institute for Scientific and Technical Communication’s magazine “Communicator” should be arriving through member’s letterboxes today. This edition is special in that contains an article on page 22 by me, entitled “Benchmarks for High Performance”. I hope people like it. We noticed this Spring 2009 edition also includes two articles by authors we’ve placed and another by a… Read more »