ComSubVies Creative Content

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):

Die schwarze Kunst der Programmierung: oder wie man etwas ganz Schwieriges lernt, ohne zu verzweifeln, wie das berüchtigte C++

Einfach und sicher beurteilen in der Kita: Mit fertigen Textbausteinen gelingen Beobachtung und Dokumentation

C++: Objektorientiertes Programmieren von Anfang anC++ auf knapp 300 Seiten im Taschenbuch-Format? Mutig. Aber machbar. Und in diesem Fall gelungen. Mit C++, Objektorientiertes Programmieren von Anfang... Read More >