Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionComponents are part of a view on a system. A component may refer to a enclosed element or to a complete system of its own.
Doctypedoctypehide
NameComponent
IDcomponent
SuiteSoftware Development
SetSoftware Developmenthide
Parent
Parent Property
parent-doctypetopic
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience

Documentation Type
Name List
doctypedoctype-type
render-no-hits-as-blanktrue
namesQ4 - System
propertyDocumentation Type

Categories
Name List
doctypecategory
names/ Process / Design
propertyCategories

Tags
Tag List
namesSoftware Development

Iteration

Iteration
value

focused

production

hide
Sort Keyhide



Section
indextrue
show-titlefalse
titleDescription

Components are modules of the system.

For larger systems a component document may describe the component briefly and link to a space with detailed information on the component. This is especially true in case the component has its own release cycle.

Components within the release cycle of the system may provided very detailed information as subdocuments of type view, architecture aspect, etc.

...

Section
titleSections


Section
titleDescription

Give a brief description of the design and the usage of the component.

In contrast to the short description this section may contain any formatting and text elements required. This section is intended to be transcluded by other documents that refer to this component.

May contain a context diagram centred on the component, but keep it very small. Also note that in case such a diagram is included, make sure to include it in every component description. Documents may transclude the abstract information from different components. Nonetheless these documents should appear monolithic to the reader. If in doubt, add the context diagram to the view section.


Section
titleSummary

Provide an overview description of the component. This summary should cover every aspect of the component from a higher level.

The summary is intended to be transcluded in overview documents.


Section
titleProperties

Provide a list of configuration options of the component.

Section
titleRequired Properties

List properties that are mandatory to run this component.


Section
titleOptional Properties

List properties that are optional to run this component.



Section
titleUse Cases

Use cases allow to define how the component is used. This section may also show use cases where the component plays only a small role. Add a reference to a use case document for each identified use case.


Section
titleQuality Scenarios

Quality scenarios document the important quality aspects of the component. Add a reference to a quality scenario document for each important quality of the component.


Section
titleArchitecture Aspects

With architecture aspects the team documents aspects that have impact on all components of the system. List the aspects that are most important for the component.


Section
titleViews

Components are important to the system. To explain their construction, runtime behaviour or deployment use view documents.

This section may also contain a context diagram.


Section
titleInterfaces

List how other components may communicate with this component over its interfaces.

Section
titleProvided Interfaces

List the interfaces provided by this component.


Section
titleRequired Interfaces

List the interfaces required by this component.



Section
titleArtifacts

List the artifacts that manifest this component.


Section
titleSubordinate Components

List subcomponents within this component.

Info Box
titleRelated Components

You may want to Reference components that are associated with this one. This makes it easier for readers to get information about those collaborators.

But this list of references is not restricted to collaboration. You may also reference components that are connected to this component in any other way. For instance, a component may be replaced by other components that implement the same interface. Listing those components may be very helpful for teams having the task to assemble a system.

This information may be part of the Interface section or have its own section.



Section
titleArchitecture Decisions

A components design or implementation may be based on some architectural decisions. List those that are important to understand the component.


Transclusion
documentDocument Sections
idsstandard-sections-bottom



Section
titleDetails


 section
Section
titleRelated Doctypes


projectdoc-
tour-macro
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue


TitleShort Description
indextrue
titleRelated Doctypes
Here is the list of related document types:




Section
indextrue
titleSub-Doctypes
Display Table
doctypedoctype
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...