RE: Drafts Back in Time

Subject: RE: Drafts Back in Time
From: Gordon Mclean <gordon -dot- mclean -at- mclarenkvisia -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 30 May 2003 16:22:34 +0100

The implication here (reading between the lines) is that we all have the
technical knowledge to write content on our own. Yes we SHOULD have a degree
of knowledge but I was always told that a Technical Author/Communicator does
not need to be a walking encyclopaedia. Our review cycle is used to ensure
the technical content of our documentation is correct. We rely on the
technical ability of developers, technical support staff, testers and SMEs
(Product Champions in our lingo).

As with most things that gets discussed on this list, it is horses for
courses. We need to provide technical information about technologies we
understand, and about products we can use, but the as we deal with
customization we need to try and give as much reference info as possible,
and that info should be as technically accurate as possible (to the point we
worry more about technical accuracy than design issues).

We don't get uptight about it, but we DO require reviews to take place. Not
for our benefit, our to make us look good, no we are actually concerned that
our customers get the information they need and that that information is

Horses for courses.

(Heads off to search the origin of that saying)

Gordon McLean
Technical Communications Manager
McLaren Ltd.

-----Original Message-----
From: Mike O. [mailto:obie1121 -at- yahoo -dot- com]

I never understood why people get so uptight about reviews.

My usual position on reviews:

1. My work is continuously available for review at [some lan/web
2. If you require reviews, fine. You know where it is; go knock
yourself out.
3. You are all big boys and girls. If you are supposed to review this
stuff, then just go do it. Or not; after all it is *your* policy.
4. I am not the review police, and I am not a human file server for
distributing review copies.
5. If you send back comments, I'll evaluate them and use them if they
are helpful -- thanks.
6. If you don't send anything back, that's fine too. I've got other
work to do.

This e-mail has been scanned for all viruses by Star Internet. The
service is powered by MessageLabs. For more information on a proactive
anti-virus service working around the clock, around the globe, visit:


Robohelp X3, from eHelp, lets you quickly and easily create
professional Help systems for all your Windows and Web-based
applications, including Net.

Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.

Order RoboHelp today:

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.

Previous by Author: RE: Term for elegant, efficient, tight code?
Next by Author: Re: Documenting Wizards
Previous by Thread: Re: Drafts Back in Time
Next by Thread: RE: Drafts Back in Time

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

Sponsored Ads