UML: TIP: show the diagram info box with creation and modification timestamp and author (unless you have a very good reason not to).

UML: TIP: show the diagram info box with creation and modification timestamp and author (unless you have a very good reason not to).

Most UML tools offer the ability to display metadata on each diagram about that diagram such as:

  • Author
  • Creation Date
  • Modification Date
  • Diagram name
  • Context
  • Owner

Use it (unless you have specific publishing reasons not to).

Some tools additionally offer the option to customise the metadata shown. Also, diagram stereotypes can be used to include additional metadata as "tagged values". Tools with support for frames enable one to show some of this metadata in the diagram frame.

Additional engineering metadata that can be very useful includes:

  • UML Profile version
  • UML Tool version
  • Any related Design Patterns
  • Engineering standards (such as ISO, IEEE)
  • Source documents and related Artifacts