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.
We use the same system as exists for the product we are documenting. We have change requests and bug tracking, but I tend to treat everything as bugs, since it's easier to deal with one system.
It doesn't have to be a bureaucratic quagmire, if you're efficient, and it can be very helpful, especially in a big project.
The first thing you should do is ask you client if you can fit the doc into the same system they use for the product.
What you should be looking for (off the top of my head) is:
- electronic way to submit requests
- ranking system, e.g. show stopper, must fix, bug, nice to have...
- assignment system (ie this job is assigned to John)
- a way of associating fixes with your version tracking system, if any
- a way to close the request (closed, no further action, fixed, etc.)
- some reporting / querying front end is nice to have
John Cornellier
> Does anyone out there deal with Document Change Request, as a formal
> process
