Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
indextrue
titleDescription

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.

Section
titleProperties
Transclusion
documentNote Box referencing common Document Properties
idsBox

Section
level2
titleType

Types allow to group views. A project demands its own definition of types via the View Type Doctype.

Section
titleLevel

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.

Section
titleSections
Section
level2
titleContext

Provide context information to understand the view documentation.

Section
level2
titleDescription

Describe what the view is all about. May include a diagram to visualize what this section describes.

Section
level2
titleElements

Add a tabular description of the elements of the view.

Section
level2
titleSubordinate Views

A complex view may be subdivided into smaller views.

Section
level2
titleRelated Views

Views that are related to this view. You may reference a deployment view for a view on the building blocks here.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...