Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
Description
The whitebox view provides information about the elements of an element and their interaction.
For many blackbox views there is a whitebox view to complete the understanding of the element.
Properties
The document type whitebox provides the following properties:
Level
The level of the blackbox inside the hierarchy.
If you have added a whitebox view as a subdocument to a blackbox view and then add references to blackbox views for each element of this view, you get an alternating hierarchy of blackbox and whitebox views.
The level represents the number of whitebox levels.
Reference
A reference to an external documentation for the element this whitebox view is about.
Sections
Description
Give a summary on the whitebox.
Diagram
Add a diagram to describe the whitebox's interals.
Blackboxes
Provide information on the blackboxes inside this element. This is the explanation of the elements you show in your diagram.
Internal Interfaces
List the interfaces relevant to the internal elements. The interfaces are not exposed, otherwise they would be documented with the parent blackbox view.
Architecture Decisions
Document the important decisions concerning the structure of this element.
Special Dependency Issues
Discuss selected complex dependencies of the local building blocks.
Open Issues
List issues that still need to be resolved.
Resources
- Blackbox - Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
