Was ist ein Schnittstellenkontrolldokument?

Ein Interface Control Document (ICD) ist eine formalisierte Beschreibung der Methoden und Strukturen, die zur Bereitstellung von Eingaben für und zum Empfang von Ausgaben aus einem bestimmten System erforderlich sind. Das im Schnittstellenkontrolldokument beschriebene System kann eine Softwarebibliothek oder eine Hardware sein. Das Dokument muss keinem einzigen Format entsprechen, sondern kann eine Sammlung von Absätzen, Diagrammen oder auch nur technischen Zeichnungen der Schnittstellenhardware sein. Wenn speziell auf Software Bezug genommen wird, kann ein Schnittstellenkontrolldokument einer Programmierschnittstelle (API) ähneln und diese abstrahieren, die die öffentlichen Methoden oder Funktionen beschreibt, die zur Eingabe von Informationen in die Bibliothek verwendet werden können, und die Ausgabe beschreibt, die resultiert. In einem Schnittstellenkontrolldokument wird allgemein beschrieben, wie das System in ein größeres System integriert oder an ein Parallelsystem angeschlossen werden kann. Es werden keine internen Abläufe des Systems beschrieben, die möglicherweise in einem separaten Dokumententyp aufgeführt sind.

Der Zweck eines Schnittstellenkontrolldokuments besteht darin, Entwicklern von Hardware oder Software eine Dokumentation bereitzustellen, die beim Erstellen eines Systems oder einer Software verwendet werden kann, die Daten zum und vom System überträgt, das vom ICD beschrieben wird. Dies bedeutet in der Regel, dass genaue Funktionen oder Hardwarekomponenten so definiert werden, dass ihre Signaturen bekannt sind und die Toleranzen der zu verwendenden Parameter angegeben werden. In der Softwareentwicklung kann dies bedeuten, den Namen einer bestimmten Funktion zu kennen, welche Arten von Variablen als Parameter akzeptiert werden und möglicherweise welche funktionalen Grenzen für die übergebenen Werte gelten. Bei einer Hardware können diese Informationen die Funktionen der Pins eines seriellen Steckverbinders, die verwendeten Hardware-Interrupts und die Arbeitsgeschwindigkeit des Geräts enthalten.

In einem Schnittstellenkontrolldokument wird nicht speziell beschrieben, wie das System Eingaben in Ausgaben umsetzt oder wie Ausgaben im Allgemeinen erzeugt werden. Auf diese Weise können Entwickler beim Erstellen einer Schnittstelle eine eng fokussierte Sicht auf das System haben. Die Entwickler des Systems müssen sich jedoch genau an die im Dokument selbst festgelegten Richtlinien halten, damit die ICD-Details eingehalten werden. Ein Vorteil für die Verfasser eines Schnittstellenkontrolldokuments und die Entwickler des Systems besteht darin, dass die interne Implementierung des Systems nicht in dem Dokument beschrieben ist und somit frei geändert werden kann, ohne die äußere Entwicklung von Schnittstellen zu beeinträchtigen, die auf dem ICD beruhen.

In einigen Situationen kann ein Schnittstellenkontrolldokument das Testen von Systemen ermöglichen, ohne dass tatsächlich eine fertige Schnittstelle verwendet werden muss. Dies kann erreicht werden, indem die verschiedenen Arten von Ausgaben simuliert werden, die ein System wie im ICD beschrieben erzeugen kann, und diese Ausgaben dann über die extern entwickelte Schnittstelle weitergeleitet werden. Systeme, die nur an einer Seite des Systems interessiert sind - wie z. B. der Ausgabe, bei Hardware wie z. B. einem Anzeigegerät - können sicherstellen, dass die Schnittstelle innerhalb der Spezifikationen funktioniert, ohne dass Eingaben in die reale Welt erforderlich sind.

ANDERE SPRACHEN

War dieser Artikel hilfreich? Danke für die Rückmeldung Danke für die Rückmeldung

Wie können wir helfen? Wie können wir helfen?