RE: New TECHWR-L Poll Question

Subject: RE: New TECHWR-L Poll Question
From: Jean Weber <jean -at- wrevenge -dot- com -dot- au>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 24 Oct 2001 19:34:24 +1000

Process guides and style guides may cover quite different issues, both of which are important in orienting writers new to a company.

Process guides (should) include things like this:

*Who is responsible for what and when (writer, editor, reviewer, manager, subject matter expert, graphic artist, and anyone else who might be involved). For example, who approves a project and its budget; who needs to sign off on a project; how many reviews are required and at what stage of a document's development; who reviews a document and for what; and so on.

* What's the timeline? (For example, at what stage of development are reviews held?)

* What procedures are to be followed to initiate a project, call a review, etc? Other planning issues. Tools to be used.

* Where are documents stored (in a directory on the LAN?), file naming conventions, document numbering, document version numbering, check-out and check-in procedures, etc.

The first three in particular are often *very* company-specific, and writers new to the company could well get in deep political doo-doo if they assume things are done they same way they were done at the previous job.

Of course they can find out this stuff without a process guide. A chat with a co-worker may suffice, and has the advantage that new writers might learn the difference between the official process and the way things are *really* done in the company. <grin>

Regards, Jean
Jean Hollis Weber
mailto:jean -at- wrevenge -dot- com -dot- au
The Technical Editors' Eyrie

Iggy wrote:

Do process is fairly similar. You write, you review,
you revise, you publish. Some omit steps, some add
steps but eventually you go from write to publish.

And Martha responded:

Well, at a very high level that is true. But what about
all those company-specific decisions that have been made
that you shouldn't have to revisit every time? You know,
things like standard dpi for graphics, line widths and
arrowheads for diagrams and callouts, Acrobat Distiller
settings--just to name a few?

It's one thing to say, "here are the templates, go to
it," and another to say, "here's a really basic style guide
that lists the decisions we've made about phrasing
and formatting so you don't have to guess how we
do things."

Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day. For details and online registration, visit

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 for more resources and info.

RE: New TECHWR-L Poll Question: From: Iggy
RE: New TECHWR-L Poll Question: From: Maggie Secara
RE: New TECHWR-L Poll Question: From: Martha J Davidson

Previous by Author: Re: MS Word, bookmark fields, and crazy numbers...
Next by Author: Re: MS Word: Right aligning heading text in a numbered heading style
Previous by Thread: RE: New TECHWR-L Poll Question
Next by Thread: RE: New TECHWR-L Poll Question

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

Sponsored Ads