Im Team schreiben: Dokumentation von technischen Schnittstellen mit Wikis

OBJEKTspektrum - Ausgabe 03/2011
Titelthema: "Stiefkind" Dokumentation

Leseprobe: An die Dokumentation einer Web-Services-API, die von Entwicklern bei externen Kunden und Partnern genutzt wird, werden hohe Anforderungen gestellt: Sie soll stets aktuell und vor allem verständlich sein, damit sie korrekt und zweckgemäß genutzt wird. Dabei ist zu berücksichtigen, dass die Entwickler die Dokumentation auf ganz unterschiedliche Art und Weise nutzen. Leider tun sich viele Entwickler mit dieser zielgruppenorientierten Art der Dokumentation schwer. Der Artikel stellt einen interdisziplinären Ansatz vor, der die kollaborativen Möglich­keiten eines Wiki-Systems nutzt, um gemeinsam eine API-Dokumentation zu erstellen und zu pflegen.

Autor(en): Ulrike Parson

Artikeljahresübersichten OBJEKTspektrum 2011

Print-Ausgabe kaufen und weiterlesen Hier lesen Als PDF herunterladen