TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
FWD: Appealing to or introducing Tech Comm "best practices"
Subject:FWD: Appealing to or introducing Tech Comm "best practices" From:Anonymous Poster <anonfwd -at- raycomm -dot- com> To:techwr-l -at- lists -dot- raycomm -dot- com Date:Fri, 22 Oct 1999 11:08:36 -0600 (MDT)
Techwr-lers,
As a technical communicator in the software industry, I rely heavily on
resources such as this listserv, STC and ACM SIGDOC publications, books by
tech writing gurus (JoAnn Hackos, William Horton, Karen Schriver), etc. to
make sure I'm on the right track and not missing out on better ways to
create documentation.
But I keep running into technical communicators who, generally because
they "fell into" the field, have no knowledge of these resources and who seem
to prefer to make up their profession and their documents as they go. While
these folks are plenty smart, mean well, and have expertise to share,
their documents often show a lack of exposure to the "standards" or "best
practices" of the field. (Not that any two tech writers could ever
completely agree on what the standards are, but there is at least some
consensus on some issues.) Also, maybe because these tech writers invented
their work without help from outside sources, they feel great ownership of
their work and can be highly defensive toward suggestions for improvement.
Does anybody out there have thoughts or advice on how to build a good
working relationship with such a colleague, while also encouraging them to
open up to the standards and best practices of the field, as described and
discussed in the major resources of the field (STC and ACM pubs, TECHWR-L,
etc.)?
I don't want to be griping or to start a gripe session here. I do want to
hear others' perspectives and suggestions. For me, this is a difficult,
serious situation, and I welcome input.
Anonymous
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Forwarded anonymously on request. If you want the
original poster to see your response, you must reply
to the TECHWR-L list. All direct replies to this
message are automatically discarded. Contact Eric
ejray -at- raycomm -dot- com with questions.