Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
The blackbox view provides information on how an element interacts with its environment.
The internals of the element are not revealed in this view.
Properties
The document type blackbox provides the following properties:
Whitebox
A reference to the whitebox view that allows a look inside this blackbox.
Typically the whitebox view is a subdocument of this view.
Level
The level of the whitebox inside the hierarchy.
If you add a whitebox view as a subdocument to this view and then add references to blackbox views for each element of the whitebox view, you get an alternating hierarchy of blackbox and whitebox views.
The level represents the number of blackbox levels.
Reference
A reference to an external documentation for the element this blackbox view is about.
Sections
Description
Give a summary on the blackbox.
Purpose
Define the purpose of the blackbox.
Diagram
Add a diagram to describe the blackbox's relationships to other components.
Interfaces
Provided Interfaces
List the interfaces this element provides for other components to use.
Required Interfaces
List the interfaces provided by other components to be used by this element.
Implemented Requirements
List the requirements implemented with this component.
Quality Attributes
List the quality attributes of this component.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
Resources
- Whitebox - Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
