TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> John Posada wrote:
>
> > I'll bet that almost every one of them would like accurate
> > documentation, but what they want more is accurate "whatever they
are
> > first responsible for". It's a matter of time and being pulled in
> > multiple directions.
>
> I think you're dead on, John. Nearly everyone I know has more work
than
> than they could possibly do. That includes the people who are expected
to
> review documentation. If you make it easy for them, you get a better
> response.
I also think that there are tech writers who think (and act!) like the
documentation is the be-all and end-all of the product. I've seen that
in action, and it's not pretty. Docs are very important, but I've never
met an engineer who didn't know that. The engineers don't work for me,
it's a cooperative relationship, and acting like they're falling down on
the job because they didn't review the documents is just
counterproductive.
I find that I can get a lot done by making sure *going in* to the review
that my information is as complete and accurate as possible. I review
the architecture documentation and the software specs, I ask questions
in project meetings about whatever piece of the documents I'm working on
that week - "Have there been any changes to the error messages since we
last spoke?" at a project meeting can save a ton of review time.
I highlight any areas of the document that I feel need careful review
(yes, theoretically it should all be reviewed carefully, whatever) to
give kind of an "if you've only got 15 minutes" benchmark.
I think the people I work with grow to trust that reviewing my documents
isn't going to be a giant time sink that they'll never get out of, and
that makes them more motivated to just get it overwith.
The Lindt truffles on my desk might not hurt either.
Carlin Equities and its affiliates? (Carlin) e-mail systems are for business purposes only. Messages are not confidential. Authorized supervisors, compliance personnel, or internal auditors may review all e-mail. E-mail will be archived for at least three years and may be produced to regulatory agencies or others with a legal right to access such information. Carlin will not accept trade order instructions via e-mail. Please telephone your firm representative or the Order Room to place trade orders.
Please be advised that any discussion of U.S. tax matters contained within this communication, including any attachment, cannot be used for the purpose of avoiding U.S. tax-related penalties or promoting, marketing, or recommending to another party any transaction or matter addressed herein.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
