RE: where do docs fit in the development process?

Subject: RE: where do docs fit in the development process?
From: "Anita Lewis" <anital -at- threerivers-cams -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 28 Jan 2002 12:08:56 -0600

>This is why you need to understand the product and technology inside
>and out. You should be working AHEAD of the engineers. Documenting
>stuff before they even coded it. Its not insane if you understand what
>they are doing and you have an established relationship with the
>engineers.
>
In my first tech writing job, most of the documentation I wrote was
based on design specs. I never saw or tested the product before I'd
produced a first draft. So I was working ahead of the engineers, and
not really having to make assumptions. I only added screen shots for
the close to final draft. Sure, some things changed from design to
release, but at least the bulk of my job was finished before the coding
was. It was much easier to go back and tweak a few things in the
documents than to start writing after all the coding was finished and
having only a week or two to complete an entire manual.
Anita Lewis
Three Rivers Systems, Inc.
Training & Customer Support
anital -at- threerivers-cams -dot- com
314.469.9648
"What can be said at all can be said clearly."
Ludwig Wittgenstein

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr

---
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: Wardrobe/shoe choice for Interviews: is height an issue for women?
Next by Author: Inventory software?
Previous by Thread: Re: where do docs fit in the development process?
Next by Thread: re: where do docs fit in the development process?


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


Sponsored Ads