froscon2008 - 1.1
FrOSCon
Free and Open Source Software Conference
| Referenten | |
|---|---|
|
Carola Sammy Kummert |
| Programm | |
|---|---|
| Tag | Day 2 (2008-08-24) |
| Raum | HS5 |
| Beginn | 10:00 |
| Dauer | 01:00 |
| Info | |
| ID | 272 |
| Veranstaltungstyp | lecture |
| Track | Development |
| Sprache der Veranstaltung | de |
| Feedback | |
|---|---|
|
Haben Sie diese Veranstaltung besucht? Feedback abgeben |
Programmdokumentation leicht gemacht
Wenn aus Hass Liebe wird
Dokumentation zu schreiben ist wohl der meistgehasste Aspekt jeglicher Programmiertätigkeit. Wider besseren Wissens verzichtet man darauf und begründet dies gern mit "Das reichen wir später nach." Die nachträgliche Erstellung von Dokumentation wird dann jedoch meist zur Quälerei und frustriert sowohl Entwickler als auch im Ergebnis die späteren Nutzer. Wie man fast nebenbei und spielend einfach eine saubere Programmdokumentation erstellen, mit der auch der Uneingeweihte arbeiten kann, erklärt dieser Vortrag.
Im Mittelpunkt des Vortrags stehen nicht nur technische Hilfsmittel, die das Erstellen von Dokumentation erleichtern. Viel wichtiger ist häufig die Motivation der Programmierer, überhaupt Dokumentation zu erstellen, reichen doch die typischen Argumente gern von "Keine Zeit" bis "das sieht man doch im Code". Richtig gemacht ist Dokumentation hingegen etwas, das sich fast von selbst schreibt und kaum zusätzliche Ressourcen benötigt, ja, das im Zweifelsfall sogar Ressourcen schaffen kann.