Zielgruppengerechte API-Dokumentation ist mehr als OpenAPI

Oft wird API-Dokumentation mit OpenAPI gleichgesetzt. Doch reicht ein OpenAPI-Dokument wirklich aus, um eine API umfassend zu dokumentieren? Gute API-Dokumentation geht deutlich über reine Referenzinformationen hinaus.

In meinem Vortrag zeige ich, welche Arten von Dokumentation unterschiedliche Zielgruppen benötigen: technische und nicht technische Stakeholder. Wir starten bei der internen Dokumentation von Architekturentscheidungen mithilfe von Canvases und arbeiten uns Schritt für Schritt vor bis zur optimalen Dokumentation für eure API-Konsumenten mit OpenAPI und ergänzender Dokumentation wie Tutorials und Use Cases.

Dabei sprechen wir über Best Practices, typische Fallstricke und die Frage, wie ihr API-Dokumentation nachhaltig in Entwicklungsprozesse integriert. So nehmt ihr praktische Impulse mit, um eure API-Dokumentation zu einem echten Mehrwert für Developer Experience und langfristige API-Qualität zu machen.