Tigerstripe Model Documentation

The modeling methodology provided with Tigerstripe Workbench guides you in the design process of a Service Contract by ensuring implementability of the designed Service Contract. Although a lot of information is carried by the Artifact model, the model requires solid documentation to be meaningful for implementation teams.

Documenting a Design

You can input documentation in Tigerstripe at various levels:

At the project level: within the Tigerstripe descriptor, you can enter a textual description of your project.
At the Artifact level: for each artifact, you can enter a textual description.
At the Artifact element level: for every single element making up an artifact (attributes, constants, methods), you can enter a textual description.

Note: You can enter valid HTML code at all levels to document your Service Contract.

What happens with the documentation?

Project documentation is stored in the model (within each artifact definition) so it can be leveraged during generation and publishing of your Service Contract.

When generating your Service Contract, the documentation associated with any element of the model is copied into the corresponding generated code. For example, for any XML element created as a result of an artifact being defined in the model, the description is copied.

When publishing your Service Contract, the documentation associated with any element of the model is copied on to the corresponding web site.