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

Haste schon gehört? parson bei der tekom-Jahrestagung 2019

Beim Trend-Slam zur technischen Kommunikation geht’s um das Neueste aus unserer Branche. In diesem neuen Format, einer Art Schlagabtausch, diskutieren die TechComm-Experten Ulrike Parson und Dieter Gust (itl) bei der tekom-Jahrestagung 2019 in Stuttgart. mehr ...

Ein Schuh ist ein Schuh ist ein Schuh. Aber Schleife ist nicht gleich Schleife

Ich bin ungeschickt und zwar nicht nur ein bisschen. Das können Ihnen meine Kollegen bestätigen. Da verwundert es nicht, dass ich seit meiner Kindheit nicht in der Lage war, die Schleifen an meinen Schuhen so zu binden, dass diese nicht nach kurzer Zeit wieder aufgingen. mehr ...

Drei Selbstläufer in Escheburg

Wenn drei Läuferinnen und Läufer von parson an einem kleinen, regionalen Volkslauf teilnehmen, stellen sie nicht nur über zehn Prozent der Gesamtteilnehmer; sie räumen auch die Preise ab. mehr ...

Bitte zweimal klingeln

Endlich! Wir sind umgezogen und haben unser altes Bürohaus in Bergedorf hinter uns gelassen. Dort war es so eng geworden, dass wir uns gegenseitig auf die Zehen traten. Außerdem war es so laut, dass uns an manchem Abend die Ohren sausten. mehr ...

Sprache für junge Nerds, E-Scooter und Sue-ees

Ulrike Parson und Uta Lange erzählen von der Frühjahrstagung in Wien. mehr ...
  • linkedin
  • xing