Within the UML 1.3 standard, all artifacts are children of the
Element
metaclass. The Element
metaclass defines a tagged value documentation
for
comment, description or explanation of the element to which it is
attached. Since this tagged value applies to every artifact, it is given
its own tab in the details pane, rather than being part of the
Tagged Values
tab.
Figure 12.7, “A typical Documentation
tab on the details
pane” shows a typical
documentation tab for an artifact in ArgoUML.
The fields on this tab are the same for all artifacts.
Author:
A text box for the author of
the documentation.
Version:
A text box for the version of
the documentation.
Since:
A text box to show how long
the documentation has been valid.
Deprecated:
A check box to indicate
whether this artifact is deprecated (i.e. planned for removal in future
versions of the design model).
See:
Pointers to documentation outside
the system.
Documentation:
Literal text of any
documentation.
![]() | Tip |
---|---|
ArgoUML is not primarily a documentation system. For artifacts
that require heavy documentation, notably use cases, the use of the
|