Geschreibsel

on

Ich muss ja ehrlich zugeben, dass wir Programmierer nicht grad den Hang dazu haben, die geleistete Arbeit mehr als ausgiebig und verständlich schriftlich zu begleiten. In-Line-Kommentare gehören schließlich auch zur Doku. Und letztenendes wissen wir ja was wir gemacht haben und wie viel Blut, Schweiß und Tränen drin stecken. Nach uns die Sintflut und derjenige ders mal übernehmen soll kann sich dann ja gleich richtig reinarbeiten. Doku stört da nur…

Manchmal, also ganz selten kommt es aber doch vor dass wir es doch tun: Doku schreiben! Aber nicht aus Gefälligkeit sondern eher, weil…

  • wir gezwungen werden
  • es so gefordert wird
  • uns verdammt langweilig ist

Freiwillig?! Never ever!

Aber, liebe Nutzer, wenn wir dann mal so ein Prunkwerk der Dokumentation geschrieben haben, womöglich noch mit dem Klangvollen Name „Handbuch“ und es auch noch mit vielen bunten Bildchen verziert haben…

DANN LEST DAS VERDAMMTE DING AUCH BEVOR IHR ANRUFT!

Und wenn ihr es schon nicht lesen wollt, dann setzt euch nicht hin, zuckt mit den Schultern und sagt, dass ihr euch das Handbuch nicht angesehen habt, weil Handbücher ja so dick sind. Lasst euch auch nicht erwischen, dass ihr gegen die Anweisung „Alles kopieren“ verstoßen habt, obwohl wir euch die Mail persönlich geschickt haben.

Solltet ihr das alles nicht beherzigen, dann gibts das nächste mal keine Doku mehr. Und dazu noch das DB2-Handbuch an die Backe!

3 Kommentare

  1. klaus sagt:

    ach komm, jetzt sei nicht so hart… ich hab ja auch nichts gegen in line kommentare, aber wenn die variablen schon so bescheuert gehalten sind (beispiel: Vwiealtister, Vbiblio) dann gehört da schon ne doku dazu, sonst checkt man den quellcode gar nicht mehr…

  2. hazamel sagt:

    Es ging eher um eine Beschreibung, welche Userspezifischen Daten in eine Property rein sollen. Vom Anwender wurde dann einfach querbeet was zusammenkopiert, nur die Hälfte kopiert. und als es dann erklärt wurde hat er fleißig mitgeschrieben und beim Hinweis aufs Handbuch nur gemeint „Die sind immer so dick (20 Seiten). Die les ich nie…“

Kommentare sind geschlossen.