Tech writers who cannot communicate

Beth Agnew beth.agnew at senecac.on.ca
Thu May 15 21:23:58 MDT 2008


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

Mike Starr wrote:
> Unfortunately, I don't think there's a way we as a profession can promote wide knowledge of what makes a document good technical writing. My approach? Provide the best document possible given the requirements of the client. I'm always glad to explain why I've done something differently from the previous writer, presenting the logical reasoning behind my approach. Hopefully, my shining examples will be viewed by the client as worlds apart from their previous documents. They may not understand why they're better at a detailed level but they ought to say they're great documents.


More information about the TECHWR-L mailing list