After covering the milestones of analysis, information gathering, planning and writing, the next phase is to ready the documentation for delivery. Delivering the quality documentation to the client is very critical. The following factors are essential in preparing the documentation for the product delivery.
Peer Review
At this point, manual now goes in the hands of the reviewers. There should be four to five reviewers for the manual; especially the ones you have been taking help from for example, analysts, developers, testers etc. After a review, the reviewed document can be a RED blanket (sigh!). The writer always turns pathetic when they get the reviewed document. Although they know that review will make the document better, still it is a little upsetting. At the end, the manual becomes very much refined in quality.
Editing
After the peer review is completed, the writer should arrange a meeting with the reviewers. It is very important to discuss the review with the reviewers. Because sometimes there is a contrast in the understanding of a feature, function, sentence structure confusion or anything else. Writers should listen to reviewers’ point of view and tell them their perspective. Everyone should come to a point, finalize the discussion and get to work.
After editing, the manual again goes into the hands of the reviewers. They read it; if satisfied the documentation is transformed into camera-ready version otherwise you have to go for another edit.
Alpha and Beta Testing
Sometimes only one testing type takes place, sometimes both occur if there are any critical problems identified in the Alpha testing. These testing steps are taken mostly in case of online and web helps. In many cases, the camera-ready documents also go for testing to check whether it matches the functionality of the product or not. This is specially done for the installation guides because the first step to use a product is the installation or quick start guide.
Printing and Proofreading
After everything has been approved and is clean by means of formatting, graphics, features and other specifics. It has now to go for printing. This part is most of the times skipped from the product deliverer. The clients/customers handle this part themselves. Sometimes it happens that the deliverer has to complete all the issues if the client does not have the resources or is ready to pay for the services. After the printing, writer has to go through it to make sure there is no printing error.
Pack and Deliver
The last part is to pack the product with guides and help or quick start cd. Deliver the package to the client.
References:
Pringle, S., Alan, O'Keefe, Sarah. Technical Writing 101: a real-world guide to planning and writing technical documentation. 2003. Published by Scriptorium Publishing.
ISBN 097047332X, 9780970473325
Tinnirello, C., Paul. 2000. Project Management. Published by CPC Press. ISBN 084939998X, 9780849399985
