Internal
design |
Class and sequence diagrams detailing the
internal design of the package. A package may have as many
internal diagrams as the designer sees fit.
Any class diagrams showing the internal design of the package should be
pre-fixed 'Internal' to clearly distinguish them from the client facing documentation.
General design diagrams should have meaningful
names.
Additional interaction diagrams may be required to show how the
implementation classes interact internally where the starting point is one of the
operations of the implementation class rather than an interface of the
package.
These should follow the naming convention:
class Name :: operation
name : optional description. If
the diagram is about the whole class and not a specific operation then
the operation name should be omitted. |
Mandatory |
These diagrams show the internal design of the
package. Most utility packages are so simple that they do not
require a large amount of internal design documentation. There should be at least one internal design diagram
showing the internal structure of the package. These
diagrams describe the structure of the design and how the structural
elements collaborate to fulfill the utility's responsibilities. |