Overview of Objecteering documentation

Overview

Welcome to the Objecteering Documentation User Guide!

The Objecteering Documentation MDAC is used to automatically generate all the documentation resulting from a model developed in Objecteering. Generated documents can then be viewed in the most widely used text editors.

Predefined document templates

Objecteering is delivered with two document templates:

· an analysis document template used to obtain an analysis document

· a design document template used to obtain a design document

Generated documentation formats

Objecteering provides four generation formats:

· Postscript: This format can only be generated in UNIX. It offers "clean" documents, even without a word processing tool. Several Postscript visualization tools are available for UNIX.

· RTF: This format, available for Windows, is the most widely used documentation format in the world.

· HTML: This is a "universal" format for both UNIX and Windows, which provides useful hypertext features, and which is used to obtain distributed and interactive documents. If you want to print your generated documentation, the Postscript and Word formats are more appropriate.

· Ascii: This format can be generated and visualized in UNIX and Windows.

Customizing your documentation

Using predefined document templates, you can define parameterization options.

The MDA Modeler tool is used to develop new document templates, which can be used to generate all sorts of other documents.