Glossary
· Ascii: This documentation format can be generated and visualized in UNIX and Windows.
· Document package: This references all the elements which should be in the documentation.
· Documentation root: Documentation generation always starts from an element in the model, to generate all the elements structured by this element. Most of the time, this is a package, but it can also be a class, an actor, a use case or another type of element.
· Document template: A document template describes how to obtain a document from a model. It entirely conditions the nature of the produced document.
· Document work product: A document work product allows you to add specific information related to the documentation in question (title, author, …), and to generate the information in the desired format.
· Generation directory: This is the directory where documentation is generated.
·
HTML: This documentation format can be
generated and visualized in UNIX and Windows. HTML
documentation can be edited by all web explorers.
· Note type: All model elements (class, attribute, association, diagram, …) have at least one "Note" type to describe them, with the two most common note types being "summary" and "description". These notes give additional information on the element in question.
· Postscript: This documentation format can only be generated and visualized in UNIX.
·
RTF: This documentation format can be
generated in UNIX and Windows, but can only be visualized in Windows.
· Tagged value: Tagged values are used to explicitly include or exclude a particular document item during generation, or to assign a specific nature to an element.