RE: bad leadership and tech writing

Subject: RE: bad leadership and tech writing
From: "Cadorette Johanne" <johanne -dot- cadorette -at- locusdialog -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 2 Nov 2001 09:20:12 -0500

Julie,

I agree with everyone's excellent suggestions.

I'd like to emphasize the importance of documenting your own
documentation process. If you don't already have one, producing a style
guide is imperative. The style guide will ensure that the documentation
has the same look and feel across the board, and that all the
information is presented in a consistant manner. A documentation roadmap
would also be useful. Map out the documentation process from a-z,
matching each step in the development process to one in the
documentation process.

Obviously, both ideas should necessitate the input of all of the writers
in the company.

Hope that helps.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author! iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers. Join our almost
10,000 published authors today. http://www.iuniverse.com/publish/default.asp

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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


Previous by Author: Re: Linux at work (real world)
Next by Author: RE: Style guides - doc standards vs processes (WAS: bad leadership an d tech writing)
Previous by Thread: Re: bad leadership and tech writing
Next by Thread: Manual Evaluation


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


Sponsored Ads