Re: Tech writers who cannot communicate

Subject: Re: Tech writers who cannot communicate
From: Beth Agnew <beth -dot- agnew -at- senecac -dot- on -dot- ca>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 15 May 2008 23:23:58 -0400

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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
RE: Definition of Tech Writer, was STC is broken: From: Michael West
RE: Definition of Tech Writer, was STC is broken: From: Michael West
Re: Tech writers who cannot communicate (was: Definition of Tech Writer, was STC is broken): From: Mike Starr

Previous by Author: Re: Tech Writer Lawsuit
Next by Author: Re: old school
Previous by Thread: Re: Tech writers who cannot communicate (was: Definition of Tech Writer, was STC is broken)
Next by Thread: RE: Definition of Tech Writer, was STC is broken


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads