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.
Subject:RE: where do docs fit in the development process? From:Erika Yanovich <ERIKA_y -at- Rad -dot- co -dot- il> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 28 Jan 2002 15:53:39 +0200
Susie,
Before you do those weird things in front of your boss's office, here's some
advice.
Let's start from your statement
<We have a pretty vigorous release/maintenance schedule.>
Take this release schedule and set an "anchor" between it and your writing
cycle, e.g., QC of the product and your second draft. Hopefully, the QC
people will test your doc together with the product. To determine when to
begin writing, count backwards from the anchor, i.e., subtract the time
needed to get to the second draft.
Now, show this concept as part of the development cycle and have some VP
approve it. The result of this should be that developers have to "initiate"
documentation as part of their work, meaning sending you raw material or
setting a meeting.
This should answer your question
<I was just wondering where documentation fits into the development cycle
where you work. How is a documentation project initiated? >
About
<Oh yeah, and how do you get developers to review your docs? I mean
actually
read them?>
your sign-off is definitely good. Apart from that, when a doc is initiated
you can set a schedule for all submissions and reviews, agreed upon by all
parties. Send it to all involved. If anything changes, resend it and state
the reason. This kind of "publicity" usually helps too.
RAD Data Communications Ltd., www.rad.com
24 Raoul Wallenberg St., Tel Aviv 69719, Israel
Ziv Towers, Building C, Room 849
Tel: 972-3-6458163, Fax: 972-3-6483331
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
