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 
Suitearc42Software Development
Setarc42Software 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
titleSections


Section
level2
titleDescription

Give a summary on the interface.


Section
level2
titleBusiness Context

Describe the functionality of the interface from the business point of view.


Section
level2
titleBusiness Processes

Describe the business processes relevant for this interface.


Section
level2
titleInterface Data

Describe the data in its technical context.


Section
level2
titleRequirements

List the requirements on the interface.


Section
level2
titleSecurity Aspects

Describe the security aspects to consider when publishing and using the interface.


Section
level2
titleQuantities

Define the quantities serviced by this interface. This addresses figures concerned e.g. with

  • Runtime
  • Throughput/Volume
  • Availability
  • Logging
  • Archiving


Section
level2
titleParticipating Resources

Resources affected when this interface is used.


Section
level2
titleSyntax


Section
level3
titleData and Formats

Define the data formats, validity and plausibility rules, encoding, character sets, and configuration data.


Section
level3
titleMethods/Functions

Describe the methods to check data.



Section
level2
titleSematics

Describe the side effects and consequences.


Section
level2
titleTechnical Infrastructure

Document the technical protocols.


Section
level2
titleError and Exception Handling

Document the codes and handling of error and exception cases.


Section
level2
titleConstraints and Assumptions

Document access rights, temporal constraints, parallel access, and preconditions for using the interface.


Section
level2
titleOperating the Interface

Document the interface from the operation point of view.


Section
level2
titleMeta Information

Document the person in charge, costs of using the interface, organizational issues, and versioning.


Section
level2
titleArchitecture Decisions

Document the architectural decisions made for the interface.


Section
level2
titleExamples of Using the Interface

Provide some examples to help users to get started with using the interface.

This may be use cases as well as coding examples.


Section
titleSubordinate Interfaces

Complex interfaces may be subdivided into single interfaces.


Transclusion
documentDocument Sections
idsstandard-sections-bottom



Section
titleDetails

This doctype is based on information provided by thearc42 Template.


Section
indextrue
titleRelated Doctypes

...