Interface control document

An interface control document (ICD) in systems engineering ^[1] and software engineering, provides a record of all interface information (such as drawings, diagrams, tables, and textual information) generated for a project. ^[2] The underlying interface documents provide the details and describe the interface or interfaces between subsystems or to a system or subsystem.

Overview

An ICD is the umbrella document over the system interfaces; examples of what these interface specifications should describe include:

• The inputs and outputs of a single system, documented in individual SIRS (Software Interface Requirements Specifications) and HIRS (Hardware Interface Requirements Specifications) documents, would fall under "The Wikipedia Interface Control Document".
• The interface between two systems or subsystems, e.g. "The Doghouse to Outhouse Interface" would also have a parent ICD.
• The complete interface protocol from the lowest physical elements (e.g., the mating plugs, the electrical signal voltage levels) to the highest logical levels (e.g., the level 7 application layer of the OSI model) would each be documented in the appropriate interface requirements spec and fall under a single ICD for the "system".

The purpose of the ICD is to control and maintain a record of system interface information for a given project. This includes all possible inputs to and all potential outputs from a system for some potential or actual user of the system. The internal interfaces of a system or subsystem are documented in their respective interface requirements specifications, while human-machine interfaces might be in a system design document (such as a software design document)^{[ citation needed ]}.

Interface control documents are a key element of systems engineering as they control the documented interface(s) of a system, as well as specify a set of interface versions that work together, and thereby bound the requirements.

Characteristics

An application programming interface is a form of interface for a software system, in that it describes how to access the functions and services provided by a system via an interface. If a system producer wants others to be able to use the system, an ICD and interface specs (or their equivalent) is a worthwhile investment.

An ICD should only describe the detailed interface documentation itself, and not the characteristics of the systems which use it to connect. The function and logic of those systems should be described in their own requirements and design documents as needed. In this way, independent teams can develop the connecting systems which use the interface specified, without regard to how other systems will react to data and signals which are sent over the interface. For example, the ICD and associated interface documentation must include information about the size, format, and what is measured by the data, but not any ultimate meaning of the data in its intended use by any user.

An adequately defined interface will allow one team to test its implementation of the interface by simulating the opposing side with a simple communications simulator. Not knowing the business logic of the system on the far side of an interface makes it more likely that one will develop a system that does not break when the other system changes its business rules and logic. (Provision for limits or sanity checking should be pointedly avoided in an interface requirements specification.) Thus, good modularity and abstraction leading to easy maintenance and extensibility are achieved.

Criticism

Critics of requirements documentation and systems engineering in general often complain of the over-emphasis on documentation. ^{[3] [4]} ICDs are often present on document-driven projects, but may be useful on agile projects as well (although not explicitly named as such). ^{[5] [6]} An ICD need not be a textual document. It may be an (evolving) table of goes-intos and comes-out-ofs, a dynamic database representing each subsystem as a DB view, a set of interaction diagrams, etc.

ICDs are often used where subsystems are developed asynchronously in time, since they provide a structured way to communicate information about subsystems interfaces between different subsystem design teams. ^{[7] [8] [9]}

There exists some confusion surrounding the relationship between Interface Requirement Documents (IRDs) and Interface Control Documents (ICDs) when defining requirements. Interface definition documents, no matter what the name, should contain only definitions – no “shall” statements!! They are agreements and statements of fact (often identified through the use of “will”). Whether you use “will” or “is” depends on where in the design process you are. Interface requirements belong in the system requirements set no matter what you call the document. These are the contractually binding “shall” statements that drive the design and must be verified. A proper interface requirement points to the definition, no matter where defined. ^[10]

References

1. Wolter J. Fabrycky, Benjamin S. Blanchard (2005). Systems Engineering and Analysis. Prentice-Hall, 2005
2. DATA ITEM DESCRIPTION, Interface Control Document (ICD), DI-SESS-81248B (2015)
3. Fowler, M.; J. Highsmith (July 2001). "The Agile Manifesto". Dr. Dobb's Journal. Retrieved 2006-05-11., "Yes, physical documentation has heft and substance, but the real measure of success is abstract: Will the people involved gain the understanding they need?"
4. Ambler, S.W. (March 2005). "Agile Modeling and eXtreme Programming (XP)". AgileModeling.com. Retrieved 2006-05-11., "...verbal communication between team members reduces the need for documentation within the team."
5. Agile/Lean Documentation: Strategies for Agile Software Development
6. Much Ado About Nothing: Documentation
7. Cutkosky, Mark R.; Jay M. Tenenbaum; Jay Glicksman (September 1996). "Madefast: collaborative engineering over the Internet". Communications of the ACM. 39 (9): 78–87. doi: 10.1145/234215.234474 .
8. Spinellis, Diomidis (November 1998). "A Critique of the Windows Application Programming Interface". Computer Standards & Interfaces. 20 (1): 1–8. doi:10.1016/S0920-5489(98)00012-9 . Retrieved 2012-12-12.
9. Leonard, Jason (May 2002). "Bringing System Engineers and Software Engineers Together" (PDF). The Rational Edge. Retrieved 2012-12-12.
10. "Interface Requirements vs IRDs vs ICDs".