Last Modified: January 10, 2003; Currently In Progress!

1. The doc lead produces a documentation project plan.
2. All the writers on the project create doc specs covering their individual doc components.
3. The doc team posts their project plan and doc specs.
4. The engineering team reviews the documentation project plan and doc specs.
5. The doc team updates the documentation project plan and doc specs as necessary.
6. The doc team writes documentation. During this time, the doc team should be working closely with R&D, QA, Product Management, and Bob Segal (our editor). At least once a week, the doc team posts their documentation on the books-in-progress Web page and encourages comments on this interim work.
7. When drafts are completed, the engineering team performs a formal review of the docs. During this time, Bob Segal will perform a thorough editorial review of the drafts.
8. When the reviewers finish, the writers turn on change bars and incorporate comments.
9. If time permits, the writers send out a second draft and reviewers focus on changed material.
10. The doc team incorporates comments from the second review cycle.
11. The doc team creates penultimate PDF and HTML version of the book.
12. Bob Segal performs a production edit on the PDF and HTML versions.
13. The doc team incorporates Bob Segal's production edits into the FrameMaker source.
14. The doc team generates final PDF and HTML, running an HTML checker.
15. The doc team posts the final PDF and HTML to the designated Completed Books area.
16. The final stages depend on the product:
    • For products other than Content Server, the doc lead checks-in all the completed documentation into that project's source code control system. The R&D release engineer ensures that the documentation is built into the final product.
    • For Content Server, the doc release engineer uses a goulash of build scripts and checkers to create a vast zip file and tar file. The doc release engineer checks these two files into Content Server's source code control system. The R&D release engineer (Dottie Slade) bakes these two files into the product itself. In addition, the doc release engineer unpacks the zip file on to the Support web site, allowing customers to access it.