Documenting Models

Design Studio automatically generates documentation for Activation cartridge modeling in HTML format and updates the documentation with each build. To access the documentation within each of the editors, navigate to the Blueprint tab. The blueprint displays documentation for the entity and provides links to the other entities.

There are some entities for which Design Studio does not generate documentation. You must include text for the following:

For for each of the three modeling elements (service action, atomic action, and action processor), you must define the Description field.
For the action processor, you must include documentation for commands used (in the Command Overview), the output of the action processor (in the Output tab), and comments (in the Development Notes tab).
For atomic actions, you must define the Data Restriction field, which enables you to specify valid range and values for parameters within the atomic action.
For service actions, you must define any properties.