DI-IPSC-81436A

Interface Design Description (IDD)

The Interface Design Description (IDD) describes the interface characteristics of systems, subsystems, and components, ensuring consistent communication and control of interface design decisions for a data product.

Approval DateDecember 15, 1999

AMSC NumberN7361

Preparing Activity—

Project Number—

OPRNAVY/EC

DTIC ApplicableNo

GIDEP Applicable—

Limitation—

Applicable Forms—

Approval Limitation—

Form Version—

DID Formatfree_text

963C CompliantNo

DISTRIBUTION STATEMENT A: Approved for public release; distribution is unlimited.

Supersedes

DI-IPSC-81436

—

Description & Purpose

—

Application & Interrelationship

—

Use & Relationship

The Interface Design Description (IDD) describes the interface characteristics of one or more systems, subsystems, Hardware Configuration Items (HWCIs), Computer Software Configuration Items (CSCIs), manual operations, or other system components. An IDD may describe any number of interfaces.

The IDD can be used to supplement the System/Subsystem Design Description (SSDD) (DI-IPSC-81432A), Software Design Description (SDD) (DI-IPSC-81435A), and Database Design Description (DBDD) (DI-IPSC-81437A). The IDD and its companion Interface Requirements Specification (IRS) (DI-IPSC-81434A) serve to communicate and control interface design decisions.

This Data Item Description (DID) contains the format and content preparation instructions for the data product generated by specific and discrete task requirements as delineated in the contract.

This DID is used when the developer is tasked to define and record the interface design of one or more systems, subsystems, HWCIs, CSCIs, manual operations, or other system components.

The IRS specifies interface requirements; the IDD describes interface characteristics selected to meet those requirements. The IDD may reference the IRS to avoid repeating information. The IDD can be used to supplement the SSDD, SDD, or DBDD.

Preparation Instructions

1General Instructions

1.1Reference documents.None.

1.2General instructions.

1.2.1Automated techniques.Use of automated techniques is encouraged. The term "document" in this DID means a collection of data regardless of its medium.

1.2.2Alternate presentation styles.Diagrams, tables, matrices, and other presentation styles are acceptable substitutes for text when data required by this DID can be made more readable using these styles.

1.3Format.Following are the format requirements. The description shall be in contractor format unless otherwise specified on the Contract Data Requirements List (CDRL)(DD 1423). The CDRL should specify whether deliverable data are to be delivered on paper or electronic media; are to be in a given electronic form (such as ASCII, CALS, or compatible with a specified word processor or other support software); may be delivered in developer format rather than in the format specified herein; and may reside in a computer-aided software engineering (CASE) or other automated tool rather than in the form of a traditional document.

1.4Content.The description shall contain the following:

1.4.1Title page or identifier.The document shall include a title page containing, as applicable: document number; volume number; version/revision indicator; security markings or other restrictions on the handling of the document; date; document title; name, abbreviation, and any other identifier for the systems, subsystems, or items to which the document applies; contract number; CDRL item number; organization for which the document has been prepared; name and address of the preparing organization; distribution statement; and signature blocks for the developer representative authorized to release the document, the acquirer representative authorized to approve the document, and the dates of release/approval. For data in a database or other alternative form, this information shall be included on external and internal labels or by equivalent identification methods.

1.4.2Table of contents.The document shall contain a table of contents providing the number, title, and page number of each titled paragraph, figure, table, and appendix. For data in a database or other alternative form, this information shall consist of an internal or external table of contents containing pointers to, or instructions for accessing, each paragraph, figure, table, and appendix or their equivalents.

1.4.3Page numbering/labeling.Each page shall contain a unique page number and display the document number, including version, volume, and date, as applicable. For data in a database or other alternative form, files, screens, or other entities shall be assigned names or numbers in such a way that desired data can be indexed and accessed.

1.4.4Response to tailoring instructions.If a paragraph is tailored out of this DID, the resulting document shall contain the corresponding paragraph number and title, followed by 'This paragraph has been tailored out.' For data in a database or other alternative form, this representation need occur only in the table of contents or equivalent.

1.4.5Multiple paragraphs and subparagraphs.Any section, paragraph, or subparagraph in this DID may be written as multiple paragraphs or subparagraphs to enhance readability.

1.4.6Standard data descriptions.If a data description required by this DID has been published in a standard data element dictionary specified in the contract, reference to an entry in that dictionary is preferred over including the description itself.

1.4.7Substitution of existing documents.Commercial or other existing documents may be substituted for all or part of the document if they contain the required data.

2IDD Structure

2.1Scope.This section shall be divided into the following paragraphs.

2.1.1Identification.This paragraph shall contain a full identification of the system and the software to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s).

2.1.2System overview.This paragraph shall briefly state the purpose of the system and the software to which this document applies. It shall describe the general nature of the system and software; summarize the history of system development, operation, and maintenance; identify the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.

2.1.3Document overview.This paragraph shall summarize the purpose and contents of this document and shall describe any security or privacy considerations associated with its use.

2.2Referenced documents.This section shall list the number, title, revision, and date of all documents referenced in this document. This section shall also identify the source for all documents not available through normal Government stocking activities.

2.3Interface design.This section shall be divided into the following paragraphs to describe the interface characteristics of one or more systems, subsystems, configuration items, manual operations, or other system components. If part or all of the design depends upon system states or modes, this dependency shall be indicated. If design information falls into more than one paragraph, it may be presented once and referenced from the other paragraphs. If part or all of this information is documented elsewhere, it may be referenced. Design conventions needed to understand the design shall be presented or referenced.

2.3.1Interface identification and diagrams.For each interface in 1.1, this paragraph shall state the project-unique identifier assigned to the interface and shall identify the interfacing entities (systems, configuration items, users, etc.) by name, number, version, and documentation references, as applicable. The identification shall state which entities have fixed interface characteristics (and therefore impose interface requirements on interfacing entities) and which are being developed or modified (thus having interface requirements imposed on them). One or more interface diagrams shall be provided, as appropriate, to depict the interfaces.

2.3.2(Project-unique identifier of interface).This paragraph (beginning with 3.2) shall identify an interface by project-unique identifier, shall briefly identify the interfacing entities, and shall be divided into subparagraphs as needed to describe the interface characteristics of one or both of the interfacing entities. If a given interfacing entity is not covered by this IDD (for example, an external system) but is interface characteristics need to be mentioned to describe interfacing entities that are, these characteristics shall be stated as assumptions or as "When [the entity not covered] does this, [the entity that is covered] will ....". This paragraph may reference other documents (such as data dictionaries, standards for protocols, and standards for user interfaces) in place of stating the information here. The design description shall include the following, as applicable, presented in any order suited to the information to be provided, and shall note any differences in these characteristics from the point of view of the interfacing entities (such as different expectations about the size, frequency, or other characteristics of data elements):

2.3.2.1Priority assigned to the interface by the interfacing entity (ies)

2.3.2.2Type of interface (such as real-time data transfer, storage-and-retrieval of data, etc.) to be implemented

2.3.2.3Characteristics of individual data elements that the interfacing entity (ies) will provide, store, send, access, receive, etc., such as:

2.3.2.3.1Names/identifiers

2.3.2.3.1.1Project-unique identifier

2.3.2.3.1.2Non-technical (natural-language) name

2.3.2.3.1.3DOD standard data element name

2.3.2.3.1.4Technical name (e.g., variable or field name in code or database)

2.3.2.3.1.5Abbreviation or synonymous names

2.3.2.3.2Data type (alphanumeric, integer, etc.)

2.3.2.3.3Size and format (such as length and punctuation of a character string)

2.3.2.3.4Units of measurement (such as meters, dollars, nanoseconds)

2.3.2.3.5Range or enumeration of possible values (such as 0-99)

2.3.2.3.6Accuracy (how correct) and precision (number of significant digits)

2.3.2.3.7Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the data element may be updated and whether business rules apply

2.3.2.3.8Security and privacy constraints

2.3.2.3.9Sources (setting/sending entities) and recipients (using/receiving entities)

2.3.2.4Characteristics of data element assemblies (records, messages, files, arrays, displays, reports, etc.) that the interfacing entity (ies) will provide, store, send, access, receive, etc., such as:

2.3.2.4.1Names/identifiers

2.3.2.4.1.1Project-unique identifier

2.3.2.4.1.2Non-technical (natural language) name

2.3.2.4.1.3Technical name (e.g., record or data structure name in code or database)

2.3.2.4.1.4Abbreviations or synonymous names

2.3.2.4.2Data elements in the assembly and their structure (number, order, grouping)

2.3.2.4.3Medium (such as disk) and structure of data elements/assemblies on the medium

2.3.2.4.4Visual and auditory characteristics of displays and other outputs (such as colors, layouts, fonts, icons and other display elements, beeps, lights)

2.3.2.4.5Relationships among assemblies, such as sorting/access characteristics

2.3.2.4.6Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the assembly may be updated and whether business rules apply

2.3.2.4.7Security and privacy constraints

2.3.2.4.8Sources (setting/sending entities) and recipients (using/receiving entities)

2.3.2.5Characteristics of communication methods that the interfacing entity (ies) will use for the interface such as:

2.3.2.5.1Project-unique identifier(s)

2.3.2.5.2Communication links/bands/frequencies/media and their characteristics

2.3.2.5.3Message formatting

2.3.2.5.4Flow control (such as sequence numbering and buffer allocation)

2.3.2.5.5Data transfer rate, whether periodic/aperiodic, and interval between transfers

2.3.2.5.6Routing, addressing, and naming conventions

2.3.2.5.7Transmission services, including priority and grade

2.3.2.5.8Safety/security/privacy considerations, such as encryption, user authentication, compartmentalization, and auditing

2.3.2.6Characteristics of protocols that the interfacing entity (ies) will use for the interface, such as:

2.3.2.6.1Project-unique identifier(s)

2.3.2.6.2Priority/layer of the protocol

2.3.2.6.3Packeting, including fragmentation and reassembly, routing, and addressing

2.3.2.6.4Legality checks, error control, and recovery procedures

2.3.2.6.5Synchronization, including connection establishment, maintenance, termination

2.3.2.6.6Status, identification, and any other reporting features

2.3.2.7Other characteristics, such as physical compatibility of the interfacing entity (ies) (dimensions, tolerances, loads, voltages, plug compatibility, etc.)

2.4Requirements traceability.This paragraph shall contain:

2.4.1Traceability from each software unit identified in this IDD to the system or to the CSCI requirements addressed by the entity's interface design.

2.4.2Traceability from each system or CSCI requirements that affects an interface covered in this IDD to the interfacing entities that address it.

2.5Notes.This section shall contain any general information that aids in understanding this document (e.g., background information, glossary, rationale). This section shall include an alphabetical listing of all acronyms, abbreviations, and their meanings as used in this document and a list of any terms and definitions needed to understand this document.

2.6Appendices.Appendices may be used to provide information published separately for convenience in document maintenance (e.g., charts classified data). As applicable, each appendix shall be referenced in the main body of the document where the data would normally have been provided. Appendixes may be bound as separate documents for ease in handling. Appendixes shall be lettered alphabetically (A, B, etc.).

References

—

Schema v3.0Community-maintained · Verify against ASSIST

Community-maintained — not an official government database.
Verify against ASSIST·GitHub·About·Disclaimer