Re: Fwd: Acceptance of Mediocre Documentation

Subject: Re: Fwd: Acceptance of Mediocre Documentation
From: John Posada <jposada01 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 25 May 2005 07:45:07 -0700 (PDT)


Anon...users don't intentionaly accept or request mediocre
documentation. They haven't been convinced of the shortcoming of
their existing documentation and the benefits of the inprovements.

Instead of saying "This piece is bad because of the following
reason", say "This piece is bad and here's the cost to the copmpany"

You need to do a little marketing of the shortcomings, why they need
to be improved, and what the benefits will be.

BTW...I don't recall ever having had the same problem, but my "thing"
(except for one gig) has always been to create new documentation, not
work on existing docs

> I have worked as a technical writer for five years,
> both as a contractor and full time employee. In all of
> my work environments with the exception of one, I have
> encountered an acceptance of mediocre documentation.


John Posada
Senior Technical Writer

?Never be afraid to try something new. Remember that a lone
amateur built the Ark. A large group of professionals built
the Titanic.? - Dave Barry

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Re: Naming Graphics SOLVED
Next by Author: Re: Fwd: Acceptance of Mediocre Documentation
Previous by Thread: Re: Military Workplace (was: Acceptance of Mediocre Documentation)
Next by Thread: Re: Fwd: Acceptance of Mediocre Documentation


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


Sponsored Ads