Re: ååï What are the perquisites to set up a company's documentation group from scratch

Subject: Re: ååï What are the perquisites to set up a company's documentation group from scratch
From: Gene Kim-Eng <techwr -at- genek -dot- com>
To: Simon <wingman1985 -at- yahoo -dot- com -dot- cn>
Date: Tue, 16 Jul 2013 10:50:00 -0700

The single most important thing to do is standardize the deliverables and the process. You need to do this even if you're a department of one because of all those engineers writing stuff, and you definitely need to do it before you hire any more document people.

All of the other things people cite, such as getting product management buy-in and reviewer cooperation, are all generic documentation needs - they exist whether there's a documentation group or not. What distinguishes a documentation GROUP from a bunch of people running around writing documents is coordination that keeps everyone moving toward the same goals instead of running off in different directions.

Gene Kim-Eng


On 7/15/2013 11:41 PM, Simon wrote:

The docs are there(written by disgrunted engineers). However, the accuracy and relevance as well as compliance is very poor. No dedicated resources are provided for this effort.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
What are the perquisites to set up a company's documentation group from scratch: From: Simon
Re: What are the perquisites to set up a company's documentation group from scratch: From: Gene Kim-Eng
ååï What are the perquisites to set up a company's documentation group from scratch: From: Simon

Previous by Author: Re: What are the perquisites to set up a company's documentation group from scratch
Next by Author: Re: Why is so hard to for majority Chinese companies to take documentation seriously?
Previous by Thread: tech writing culture in China (was: perquisites to set up a ... doc group
Next by Thread: RE: What are the perquisites to set up a company's documentation group from scratch


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

Sponsored Ads


Sponsored Ads