projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 1

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 2

changes.mady.by.user Robert Reiner

Saved on

Key

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

...

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.

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.

projectdoc-section
titleSubordinate Interfaces

Complex interfaces may be subdivided into single interfaces.

projectdoc-transclusion-macro
documentDocument Sections
idsstandard-sections-bottom

...

Section
titleReferences

Section
titleResources

 

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH