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: Documentation Process -- LONG From:Barb Einarsen <barb -dot- einarsen -at- gnnettest -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 8 May 2001 10:43:58 -0400
I'll share my process with you and I'd like to see other processes.
Since we use a 3rd party writing company, some of the steps may be unique
(but I think it all translates to a regular writing department).
I should also mention that a lot of our products are developed by 3rd party
companies as well (which explains why we don't do many UI reviews).
I'm breaking the process into 2 parts, one for the manager, one for the
writer.
PROJECT 1
Manager:
* finds out about the project from R&D and gets an estimated deadline
* adds project to a list of all projects (organized by release Quarter)
* coordinates all known projects for the upcoming Quarter
* coordinates, with the 3rd party writing company management, the available
writers for the upcoming Quarter
* assigns writers to projects
* identifies when the project is ready for the writer to start (due to tight
budgets, we have to make sure enough information is available before
starting)
Writer:
* when project is ready to start, the writer comes in for 1 or 2 days and
does all research, interviews, demos ...
* the writer takes the information gathered and creates a Documentation Plan
(sometimes a Documentation and Training Plan)
* the Documentation Plan is signed by the writer and passed to the manager
NOTE: the Documentation Plan includes estimated hours, the project
milestones and the pricing.
Manager:
* approves and negotiates the approval of the Documentation Plan (the plan
is signed off by the manager, the VP, the business unit manager, and the R&D
project manager)
* when the plan is signed off, the writer can start work (often can't wait
for official approval)
Writer:
* creates a first draft and sends it for review (repeat for each deliverable
in the Plan)
Manager:
* reviews all drafts and helps the writer receive all feedback by the
deadline (if required)
Writer:
* integrates the comments and creates the final version (repeat for each
deliverable)
* works with the R&D build team to ensure the correct information goes on
the CD
* cleans up the source directories and archives the information
* distributes the information internally by updating the public archives
Barb Einarsen
Manager of Product Information Development
GN Nettest, Markham office
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
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.
