QotD: Documentation

I have encountered far too many managers who couldn't recognize bad documentation at all. Until the flaws are pointed out to them, or they compare it with good documentation, they are oblivious. That is why there are also far too many people working as technical writers who should be wearing greasepaint and ruffled collars instead. Those of us who are competent should be continually educating our co-workers and managers by pointing out excellent examples of technical communication.

We have a lot of fun commenting on the bad examples, but I think we should be showing off the good ones much more than we do now.

Beth Agnew, posting to the Technical Writing mailing list TECHWR-L, 2008-05-15