Producing Documentation

Together includes a documentation generation tool that allows you to quickly track the progress and quality of your development. The results are html-based and easily shared with a team. A wizard guides you through the process of producing a set of documents. These display in a web browser frameset. From within the frameset you can navigate to javadoc, diagrams, or QA details using either an applet navigator or SVG diagrams with navigable hot spots (both of these are provided). The hyperlinks and directory structure are self-contained, ready for deployment to your intranet site if desired.

The Generating Documentation task in this section provides a step-by-step overview of the process. However, the wizard used contains a number of options that only detailed in the Documentation Wizard and Documentation Output pages in the Reference section.


Related Topics:

Generating QA Reports
This is the same QA report that you can choose to include in Documentation Generation, but it can also be generated separately as a stand-alone document.

Printing Diagrams
Documentation Generation includes SVG versions of your project diagrams, but these can also be printed singly from the Diagram View.

Printing Source Code
Produced from the editor view in Together. Code is not included in this raw form in document generation.