Tips zum Schreiben von Dokumentationen
Posted on 13. Nov, 2009 by Markus Schabel in Informatik
Jacob Kaplan-Moss ist an der Phyton Dokumentation beteiligt und hat eine Serie von 3 Artikeln (Writing good documentation) herausgegeben, in der er zusammenfasst, worauf man achten muss, wenn man eine gute Dokumentation schreiben will. Die Serie besteht aus den 3 Teilen What to write, How to write und you need an editor. Man sollte sich diese Artikel zumindest einmal durchgelesen haben, weil hier durchaus schön zusammengefasst wird, worauf es ankommt – und auch welche Unterschiede es zwischen Online-Dokumentationen und gedrucktem Material gibt.
Und nicht vergessen:
Documentation is like sex, when it’s good it’s really really good and when it’s bad it’s better than nothing at all.
Verwandte Literatur (amazon):
Java: Programmieren von Anfang anJava. Programmieren von Anfang an.
Technische Dokumentation: Praktische Anleitungen und Beispiele (VDI-Buch)Die 2. Auflage führt das bewährte Konzept - angereichert mit neuen Beispielen - weiter. Der Autor gibt einfach nachvollziehbare Vorgaben in Form von... Read More >
Markus Schabel
Nov 13th, 2009
Es wäre interessant zu wissen, woher das Zitat kommt. Ich habe es ursprünglich von Colin Wheeler’s Blog Code Samurai zum Thema Objective C Dokumenation mit Doxygen in Xcode gefunden, auf Stack Overflow wird es jedoch Dick Brandon zugeordnet…