Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
Different views on your product help to document the system and its architecture. Typical views are building block, runtime, or deployment. You may define you own types of views to meet your documentation requirements.
The document type view provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Defines the level of this view in the containment hierarchy of views.
Consider to use the Level Macro to calculate this information based on the location of this document within the hierachy of view documents.
Provide context information to understand the view documentation.
Describe what the view is all about. May include a diagram to visualize what this section describes.
Add a tabular description of the elements of the view.
A complex view may be subdivided into smaller views.
Views that are related to this view. You may reference a deployment view for a view on the building blocks here.
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.
The text of notes sections is also indexed.
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.
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.
Components are often detailed by view documents.
Architecture aspects are often used together with view documents to describe components.