Kontextabgrenzung
Form
- Diverse Kontextdiagramme (siehe folgende Abschnitte)
- Listen von Nachbarsystemen mit deren Schnittstellen.
Fachlicher Kontext
Form
Logisches Kontextdiagramm, in der UML z.B. simuliert durch Klassendiagramme, Use Case > Diagramme,Kommunikationsdiagramme - kurz durch alle Diagramme, die das System als Black Boxdarstellen und die Schnittstellen zu den Nachbarsystemen (mehr oder weniger ausführlich)beschreiben.
Alternativ oder ergänzend können Sie einfach eine Tabelle verwenden. Der Titel gibt den Namen Ihres Systems wieder; die drei Spalten sind: Nachbarsystem, Input, Output. Auch so kommen Sie zu einer kompletten Schnittstellenbeschreibung.
Technischer- oder Verteilungskontext
Form z.B.: UML Deployment-Diagramm mit den Kanälen zu Nachbarsystemen, begleitet von einer Mapping-Tabelle Kanal x Input/Output.**
Externe Schnittstellen
Externe Schnittstelle 1
Identifikation der Schnittstelle
| Name / Bezeichnung der Schnittstelle | Version | Änderungen gegenüber Vorversion | Verantwortlicher Ansprechpartner / Rolle | Wer hat geändert und warum? |
|---|---|---|---|---|
| Name der Schnittstelle |
Fachlicher Kontext der Schnittstelle
Fachliche Abläufe
- Diagramm oder Beschreibung der fachlichen Abläufe
Fachliche Bedeutung der Daten
- Beschreibung der fachlichen Bedeutung Technischer Kontext Form der Interaktion
Anforderungen an die Schnittstelle
Sicherheitsanforderungen
Mengengerüste
- Laufzeit
- Durchsatz / Datenvolumen
- Verfügbarkeit
- Protokollierung
- Archivierung
Beteiligte Resourcen
Syntax: Daten und Formate
- Datenformate
- Gültigkeits- und Plausibilitätsregeln
- Codierung, Zeichensätze
- Konfigurationsdaten
Syntax: Methoden/Funktionen
- Prüfdaten
Ablauf der Schnittstelle
- fachliche oder technischer Ablauf
Semantik
- Nebenwirkungen, Konsequenzen
Technische Infrastruktur
- Technische Protokolle
Fehler- und Ausnahmebehandlung
- Welche Fehler werden erkannt?
- Wie werden sie intern behandelt?
- Welche Fehler werden nach aussen gegeben?
Einschränkungen und Voraussetzungen
- Berechtigungen
- Zeitliche Einschränkungen
- Parallele Benutzung
- Voraussetzungen zur Nutzung
Betrieb der Schnittstelle
Metainformationen der Schnittstelle
- Verantwortliche
- Kosten der Nutzung
- Organisatorisches
- Versionierung
Beispiele für Nutzung und Daten
- Beispieldaten
- Beispielabläufe / -interaktionen
- Programmierbeispiele