Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionInterfaces document how elements of the system communicate with elements of this and other systems. 
Doctypedoctypehide
NameInterface 
IDinterface 
SuiteSoftware Development
SetSoftware Developmenthide
Parent
Parent Property
property-nameName
 
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
namesExtension, Software Development
 
Iteration
Iteration
valuefilled
hide
Add-onarc42 Add-on 
Sort Keyhide



Section
indextrue
titleDescription

Interfaces document how elements of the system communicate with elements of this and other systems.

...

Section
titleProperties


Transclusion
documentNote Box referencing common Document Properties
idsBox


Section
level2
titleIdentifier

Define the unique technical identifier of the interface.


Section
level2
titleVersion

Specify the version of the interface that is described by this document.


Section
level2
titleType

Define the type of the interface which may be internal (used by components of the system you design) or external (also used by components outside the system you design).The value is edited by the use of the Interface Type Macro.


Section
level2
titleLevel

The level is relevant if you want to document an interface by individual parts.


Section
level2
titleReference

Add references to information on external systems here.  This is useful if the documentation for an interface is defined elsewhere or may be provided by the interface on-demand.


...