Wie schreibt man gute API-Dokumentation?

Wenn Software-Entwickler APIs programmieren, steht die Dokumentation oft hinten an. Erst wenn der Fertigstellungstermin nahe rückt oder bereits in Gefahr ist, denkt man an sie. Häufig müssen die Entwickler dann die Dokumentation selbst schreiben. Die arbeiten jedoch unter Hochdruck daran, den Projekttermin zu halten: sie lösen Bugs und nehmen allerletzte Änderungen vor.

Es gibt Software-Entwickler, die beides können: programmieren und schreiben. Meistens sind Entwickler aber besser im Programmieren. Und mal ehrlich, viele Entwickler finden Dokumentation einfach nur mühsam.

Bisher habe ich nur wenige Informationen über das Schreiben von guter API-Dokumentation gefunden. Bis ich vor einigen Tagen auf diesen MSDN-Artikel von Peter Gruenbaum stieß.

Ulrike Parson hat sich in ihrem Artikel Documentation for Software Engineers ebenfalls mit dem Thema befasst.

Blog

tekom-Jahrestagung 2018: Was gibt’s Neues bei iiRDS?

iiRDS war zentrales Thema auf der tekom-Tagung: das iiRDS-Café, Fachvorträge, Showcases und Tutorials widmeten sich dem neuen Standard. Auch auf Twitter wurde diskutiert, unter anderem über den für US-Kollegen so schwer auszusprechenden Namen. mehr ...

tekom-Bericht Teil 3: Kreativität statt Langeweile – Online-Videos für die technische Doku

Manege auf! Zu Beginn seines Workshops „Packende Online-Videos mit einfachen Mitteln erstellen“ zeigte Stephan Schneider zwei Bilder. mehr ...

tekom-Bericht Teil 2: Über echte und virtuelle Überflieger

Die tekom begrüßt mich mit strahlendem Sonnenschein. Drinnen sind Tagung und Messe bereits in vollem Gange. Zwei Tage Vorträge, Workshops, Messebesuch und Gespräche warten auf mich. mehr ...

tekom-Bericht Teil 1: Überwarnung ist real

Auf der tekom-Jahrestagung war das Informationsangebot zu Normen und Richtlinien groß. Unter anderem fanden sich Normungsexperten wie Jens-Uwe Heuer-James und Torsten Gruchmann zu einer Podiumsdiskussion zusammen, in der immer wieder anklang: Wir brauchen eine IEC 82079-1. mehr ...

Arbeiten in selbstführenden Teams. Oder wie wir das Management abschaffen

Die Welt von heute ist VUCA: volatile, uncertain, complex und ambiguous. Unternehmen stehen vor komplexen Herausforderungen wie Industrie 4.0 und dem Internet der Dinge. Wer nicht schnell genug agiert, wird vom Markt verdrängt. mehr ...
  • linkedin
  • xing