Events

13.06.2018 - 13.06.2018

API Dokumentation (Schnittstellen-Dokumentation) zielgruppengerecht erstellen

Date 13.06.2018
Time 18:00 Uhr bis ca. 20 Uhr
City SAP Campus Walldorf, Gebäude WDF21 – 4ter Stock, Raum F4.02 (alias "Präsent F2")
Organizer tekom RG Baden (Ariane Anders)
Email rg-baden@tekom-webforum.de
Files tekomVeranstaltung_130618_API-Doku_WDF19-21Anfahrtsbeschreibung.pdf

Programmierschnittstellen (APIs) spielen in modernen Softwarearchitekturen eine zentrale Rolle - entsprechend gewinnt auch die Dokumentation von APIs immer mehr an Bedeutung.

Auswahl, Strukturierung und Darstellung der Informationen stellen Technische Redakteure jedoch immer wieder vor Herausforderungen. Dieser Vortrag
diskutiert Strategien für die Optimierung von API-Dokumentation, die sich auf Inhalt, Struktur, Layout sowie die Kombination von Text und Code-Beispielen in API-Dokumentation beziehen.

Der Vortrag erläutert konkrete Gestaltungsempfehlungen für die Umsetzung dieser Strategien sowie empirische Befunde, die die Wirksamkeit der vorgeschlagenen Empfehlungen stützen. 

In einer Studie wurde dafür API Programmierer befragt und Usability-Tests mit einer optimierten API Dokumentation durchgeführt.

ACHTUNG Raumänderung am 05.06.2018: Das Regionaltreffen findet in einem anderen Gebäude statt als sonst. Eine Datei mit der Anfahrtbeschreibung ist hochgeladen.