8.2.5 Interface Description (IfDe)
This product contains a description of each interface identified in the Interface Overview. Identification, syntax and semantics must be documented for each interface. The exact content to be described depends on the type of interface and on the elements connected.
Apart from the interfaces on SW Component, SW Module and Database level, the product describes all system interfaces, whereby it is basically possible to structure the product into several individual products, according to certain criteria.
1. General Information
2. Description of the Interfaces
2.I. Interface (i)
2.I.1. Use of the Interface
2.I.2. Syntax of the Interface
2.I.3. Semantics of the Interface
See schema 1. General Information.
The individual subitems must refer to the special characteristics of the various interfaces between the participating elements, i. e. System, user, Segment, SW Unit, HW Unit, SW Component, SW Module, or Database.
Note: "i" is used for consecutive numbers of the Interface Description from 2.1 to 2.n and as place holder for the interface identification according to the conventions for identification defined in the CM Plan.
The elements participating in the interface (functional units, user, external elements) and the purpose of the interface have to be documented.
The technical structure of the interface must be described exactly. Depending on the type of the interface, the following information is required:
The information and operations exchanged via the interface have to be described, also how the interface is placed, and how it is represented from the point of view of the System.
Depending on the type of the interface, special characteristics like performance data or time requirements have to be described as well as information about the use and operation, etc.
- function call and parameter list,
- direction of transmission,
- communication protocol,
- synchronization mechanism,
- layout of a user interface, etc.
Last Updated 01.Jan.2002
Updated by Webmaster
Last Revised 01.Jan.2002
Revised by Webmaster