Mehr Verständlichkeit an der Schnittstelle

Text: Michael Meng Stephanie Steinhardt

In einer vernetzten Welt gewinnen Programmschnittstellen, APIs, an Bedeutung. Da APIs nicht selbst­erklärend sind, braucht es eine gute Dokumentation. Doch wie sollte sie aussehen, damit Entwickler optimal unterstützt werden? Die Forschung der Hochschule Merseburg liefert Antworten.

Im Bereich der Softwareentwicklung sind ganz verschiedene Arten von Dokumentationen anzutreffen. Für die Endnutzer von Software gibt es zum Beispiel die Anwenderdokumentation, meist geschrieben von Technischen Redakteuren. Sie klärt vorrangig die Nutzung der Software. Demgegenüber steht die Entwicklerdokumentation, meist stammt sie von Entwicklern, die die technische Seite hinter der Benutzeroberfläche dokumentieren. Die Anwenderdokumentation verlässt das Unternehmen und ist für eine externe Verwendung bestimmt. Die Entwicklerdokumentation wird hingegen intern genutzt.

Die Dokumentation von APIs (Inf. 01) reiht sich zwischen diese beiden Arten der Softwaredokumentation ein. Die API-Dokumentation ist eine überwiegend technische Beschreibung von Architektur und Code und verlässt das Haus, da sie für externe Entwickler bestimmt ist.

Definition von API

API ist das Kurzwort ...

Mehr Verständlichkeit an der Schnittstelle

Mehr Verständlichkeit an der Schnittstelle