Software > Software-Tipps > Softwaredokumentation > Schnittstellen-Dokumentation
4.3.

Schnittstellen-Dokumentation


Beurteilen und Bewerten vorhandener Schnittstellen
Welche Import- und Export-Schnittstellen gibt es und inwieweit sind sie dokumentiert?

Eine der häufigsten Fragen, die in Zusammenhang mit der Suche nach Software insbesondere bei Branchenlösungen gestellt werden, ist die Frage nach der Import-Schnittstelle. Können vorhandene Daten in die Anwendung übernommen werden? Verständlicherweise ist das eine der ersten aufkommenden Fragen.

Schnittstellen sind die Verbindungspunkte zwischen verschiedenen Systemen. Neben Hardware-, Benutzer- und Systemschnittstellen sind bei einer Software meist die Import & Export-Schnittstellen von größerer Bedeutung. Über die Import-Schnittstellen können externe Daten, die aus der alten bzw. bereits vorhandenen Software oder aus anderen Programmen kommen, eingelesen werden. Dieser Import klappt nur, wenn die Daten in einem bestimmten, der Software bekanntem Format, vorliegen. In welcher Form die Software Daten benötigt, um sie zu importieren, sollte dokumentiert sein. Neben dem Datenformat (DBF, TXT, CSV, XML …) sind Angaben über die Namen der Datenfelder, ihrer Formate und Größen sinnvoll.

Zur Unterstützung des Datenimports sind sogenannte Importassistenten hilfreich. Dies sind spezielle Programmmodule, die den Benutzer auch beim Import komplizierter Datenformate mit Dialogen schrittweise unterstützen.

Für die Export-Schnittstelle gilt das Gleiche wie für die Import-Schnittstelle, nur dass hier Daten erzeugt werden. Diese exportierten Daten können als Sicherung benutzt oder in eine anderes, etwa ein neues Programm, eingelesen werden.

Der Datenimport wird von Softwareanbietern meist gut unterstützt, damit alte Programme von anderen Anbietern unkompliziert abgelöst werden können.

4.2. Online-Dokumentationen4. Softwaredokumentation4.4. Programmdokumentation