04. Oktober 2022 | Regionalgruppe Süd-Niedersachsen

API-Dokumentation zu optimieren, heißt von Software-Entwickler:innen zu lernen

Veranstaltungsinformationen | Anmeldung

In einer Welt in der alles mit allem vernetzt ist, gibt es zahllose Schnittstellen. Diese Programmierschnittstellen (API) sind zu dokumentieren. Insbesondere sogenannte Web APIs gewinnen in einer smarten Umgebung immer mehr an Bedeutung. Web APIs sind Programmierschnittstellen, über die Softwareanwendungen Daten und Services per Internet bereitstellen und nutzen können. Web APIs ermöglichen vielfältige neue Geschäftsmodelle und sind zentrales Element digitaler Transformationsprozesse.

Die immens gewachsene Bedeutung von Web APIs hat das Thema API-Dokumentation als Teil der Softwaredokumentation beinahe schlagartig in den Fokus gerückt. Denn rasch wurde klar: Für die produktive Nutzung von Web APIs sind Informationsprodukte notwendig, die die Arbeitsweise und Informationsbedarfe von Software-Entwickler:innen zielgenau unterstützen. Wie kann dies Ziel erreicht werden? Der Frage, was zeichnet erfolgreiche API-Dokumentation aus, steht im Zentrum des Vortrags wie auch eines Forschungsprojekts der Hochschule Merseburg.

Erläutert wird zunächst, wie Software-Entwickler:innen an neue Programmieraufgaben mit Web APIs herangehen und was sie von guter Dokumentation erwarten. Aufbauend darauf werden Leitlinien für die Optimierung von API-Dokumentation entwickelt und konkrete Umsetzungsbeispiele zur Diskussion gestellt.

Michael Meng ist Professor für Angewandte Sprachwissenschaft an der Hochschule Merseburg und hat das Projekt „Optimierung von Software-Entwicklerdokumentation - was brauchen Entwickler wirklich?“ geleitet.