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.

Kommentar schreiben


Blog

Über Lampen, Birnen und Fluchtinstinkte. Nachschlag zur tekom-Tagung 2019

Im letzten Teil unserer tekom-Nachlese gehts um Erleuchtungen in einem Terminologieworkshop und Fehlermeldungen, die den Fluchtinstinkt in uns wecken. mehr ...

KI als Chance oder Bedrohung für den Technischen Redakteur? Bericht von der tekom-Tagung, 3. Teil

Der Begriff Künstliche Intelligenz (KI) ist ein Phantom. Jeder Mensch assoziiert sofort etwas damit, doch die Vorstellungen sind selten deckungsgleich. mehr ...

Sprung ins kalte Wasser oder wie ich das erstmal Mal slammte. Bericht von der tekom-Tagung, 2. Teil

Eigentlich bin ich ja ein alter Hase bei der tekom-Tagung und sollte nicht mehr allzu aufgeregt sein, wenn ich einen Vortrag halte. Aber als Dieter Gust und ich unsere Feierabend-Schnapsidee einer scherzhaften Debatte (Trend-Slam) auf die Bühne brachten, war mir doch etwas flau im Magen. Wie würde das wohl ankommen? mehr ...

Der-die-das, drei Redakteure gehen essen und ein Könjunktiv. Bericht von der tekom-Tagung, 1. Teil

Eine Referentin irritierte mich, weil sie konsequent von "dem" Engine sprach, der in der Software für die maschinelle Übersetzung zuständig ist. Ich benutze bei Engine immer "die".  mehr ...

Der iiBot gibt Anweisung

Ein Chatbot, der dem Servicetechniker genaue Anweisungen für seine akute Fragestellung gibt – live, anwendungsgerecht und zugeschnitten auf die Qualifikation des Servicetechnikers. mehr ...
  • linkedin
  • xing