Overview of this quick tour

Introduction

Objecteering MDA Modeler can be used to create new documentation templates. This quick tour project presents an example, which illustrates the creation of a documentation template used to generate the principal information on a package of classes.

The documentation template we are going to create is shown in Figure 30 below.

Figure 30. The documentation template we are going to create in this quick tour project

This documentation template will allow us to generate the following documentation in HTML format for a class (Figure 31).

Figure 31. The documentation generated using the documentation template shown in Figure 30

Procedure

There are three distinct stages to this quick tour project:

· a preparatory stage

· a modeling stage

· an MDA component production stage

The preparatory stage consists of preparing your development environment. This involves creating a dedicated project and deploying the MDA Modeler MDAC (please see “Getting started”).

The modeling stage is dedicated to the creation of your J MDA component, and the creation and development of your documentation template, which will later be packaged in the new J MDA component. For more information, please see “Creating an MDA component”, “Creating a new documentation template” and the sections that follow.

During the MDA component production stage, the MDA component created during the modeling stage is completed, before being tested, compiled and packaged, ready for deployment. For more information on the MDA component production stage, please see “Installing and using an MDA component” section in this chapter, and the sections that follow it.