Tech Comm’s Place in the Choir

All God’s creatures got a place in the choir
Some sing low and some sing higher
Bill Staines

Birds on a wire

A place in the choir

Traditionally, technical manuals have been written as if they were the only source of information on a product. Of course, the manual was never really the only source. There have always been neighbors, friends, colleagues, retailers, user’s groups, and professional associations to learn from as well.  But access to these other sources of information was not universal, and those groups themselves had to learn from somewhere — information had to propagate through the network before it became available to the ordinary user, and the propagation was usually quite slow. It was reasonable, therefore, for users to look on the documentation as their principle source of information, and it was reasonable and necessary for the documentation to be written as if it were the sole source of information on a product. Not any more. read more

Why documentation analytics may mislead

I was rereading some material in the long-running do-people-read-the-manual debate (such as Tom Johnson’s If No One Reads the Manual, That’s Okay), and it struck me that there is an assumption that people on both sides of this debate are making which deserves some scrutiny. We all assume that technical documentation operates at first hand. That is, we assume that when a user wants help, they get that help directly by reading the manual or the help system or by watching a video, etc. I don’t think that assumption is correct. In fact, I’m convinced that it is naively and dangerously wrong, and that measurements and decisions based on this assumptions may be fundamentally flawed and harmful to a company and its customers. read more