12 Dokumentation
12.1 Motivation
In vielen Softwareprojekten kommt das Thema Dokumentation zu kurz, weil es als Aufgabe mit geringerer Priorität behandelt wird. Die API einer Softwarebibliothek oder eines Webservice ist jedoch komplexer als die grafische Benutzeroberfläche eines Smartphones. Eine gute Dokumentation ist daher unverzichtbar und der Schlüssel zum Erfolg der API oder sogar des gesamten Projektes. Verschiedene Ziele werden mit einer API-Dokumentation verfolgt:
Entwickler sollen ermutigt werden, die API zu nutzen. Eine vernünftige Einstiegsdokumentation mit möglichst wenigen Marketing-Phrasen ist daher sehr wichtig. Ziel ist es, die Einstiegshürden zu minimieren, dennoch sollte die Dokumentation auch auf die Fragen von fortgeschrittenen ...
Get API-Design, 1st Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
