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

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

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

Wie beinflusst die Digitalisierung die Arbeit der Technischen Redakteure?

Mit der Digitalisierung ändern sich Produkte, Produktionsprozesse und das Nutzungsverhalten. Daraus resultieren neue Anforderungen an die Arbeit der Technischen Redakteure. mehr ...

Vom Geisteswissenschaftler zum Technischen Redakteur

"Und, was willst du machen, wenn du fertig bist?" Welcher Student kennt diesen Satz nicht? Besonders Geisteswissenschaftlern fällt es oft schwer, auf die Frage eine zufriedenstellende Antwort zu finden. Der deutsche Arbeitsmarkt sucht schließlich Elektroingenieure oder Informatiker und keine Historiker mit Spezialisierung auf die Antike wie mich. mehr ...

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 ...
  • linkedin
  • xing