wie faßt Ihr Euer Wissen zusammen, daß Ihr z.B. durch Büchern, Internetartikel, Erfahrungen gesammelt habt, um nichts zu vergessen, aber auch nicht jede Menge Ordner anlegen zu müssen, um die Ausdrucke von den Artikeln ... zu archivieren? Ich frage deshalb, weil ich momentan nicht nur privat damit zu tun habe, sondern auch beruflich für meine Nachfolger meine Dokumente hinterlassen muß. Ich bin als Quereinsteiger in den Bereich gekommen, und habe mir alles selber angeeignet, so daß ich nicht weiß, wie man das professionell macht ... Könnt Ihr mir hier ein paar Tips zu geben?

Im voraus vielen Dank!

Viele Grüße,
Arwen

Programmwissen beim Programmieren liefert die Dokumentation.

Ansonsten habe ich nie mehr gebraucht :-\

vielen Dank für Eure Antworten, die einige nützliche Anregungen enthalten. Ich sollte befördert werden, wechsel den Betrieb aber jetzt weil ich woanders eine bessere Stelle angeboten bekommen habe, und kann meinen Nachfolger nicht mehr selber direkt einarbeiten, weil er noch gar nicht eingestellt wurde. Deshalb meine Nachfrage. Ich möchte mir natürlich die Türe offenhalten zu der Firma zurückgehen zu können, und möchte deshalb kein Chaos hinterlassen ...

Viele Grüße,
Arwen

Hallo,

wie faßt Ihr Euer Wissen zusammen, daß Ihr z.B. durch Büchern, Internetartikel, Erfahrungen gesammelt habt, um nichts zu vergessen, aber auch nicht jede Menge Ordner anlegen zu müssen, um die Ausdrucke von den Artikeln ... zu archivieren?

Ich habe keine Ordner. Bei mir sind es Pappkartons. Umzugskisten.
Und neuerdings ein Einzugsscanner, um dem ganzen Herr zu werden und es als PDF auf einer CD zu haben.

Wirklich wichtiges, interessantes Wissen, das ich nicht wieder vergessen möchte, schreibe ich auf.
Manches packe ich auf meine Website, vieles verschwindet auf meiner Festplatte, manches schreibe ich in Buchform, layoute es und drucke es Nachschlagwerk aus. Aber das mache ich wirklich nur bei Dingen, die google nicht schneller für mich löst.
Auf meinem Laptop läuft eine MediaWiki-Installation, die ich zusätzlich benutze.
Sourcecodes dokumentiere ich mit Doxygen.

Arwen schrieb:

Ich frage deshalb, weil ich momentan nicht nur privat damit zu tun habe, sondern auch beruflich für meine Nachfolger meine Dokumente hinterlassen muß.

Wie Du die Sachen beschreibst, wäre mir als Nachfolger egal. Erstmal ist schon gut, wenn überhaupt etwas existiert. Das Format wäre mir da egal, hauptsache leicht lesbar (PDF, DOC, ...) und im Idealfall veränderbar(DOC, OpenOffice..). Wenn viele damit arbeiten müssen, sollten Änderungen leicht einspielbar sein (Wiki auf Webserver).

Arwen schrieb:

Ich bin als Quereinsteiger in den Bereich gekommen, und habe mir alles selber angeeignet, so daß ich nicht weiß, wie man das professionell macht ... Könnt Ihr mir hier ein paar Tips zu geben?

Professionell...?
Zitate hebe ich in einer Datenbank auf und die warf u.a. folgendes zum Thema Dokumentation raus.
Wenn man sich überlegt, warum es solche Zitate überhaupt gibt, versteht man vielleicht, was professionelle Dokumentation ist.

Dick Brandon schrieb:

Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing.

Real Programmers write programs, not documentation.

Real Programmers don't draw flowcharts. Flowcharts are the illiterate's form of documentation. Cavemen drew flowcharts; look at how much good it did for them.

A bug in the code is worth two in the documentation.

As long as there are ill-defined goals, bizarre bugs, and unrealistic schedules, there will be Real Programmers willing to jump in and Solve
The Problem, saving the documentation for later.

Folgendes passt nicht so ganz, aber ich fand's trotzdem gut

Help text from Essex Dec 10 schrieb:

HELP SEX: This system is a computer and as such is not able to help with enquiries of this nature. For details on reproduction, see the Xerox documentation

Selbstverständlich solltest Du es besser machen. Ich habe Dir ein paar Möglichkeiten genannt, die Du auf Dein Problem abgleichen kannst. Vielleicht fragst Du einfach mal Deinen Kunden/Chef/Nachfolger, in welcher Form sie sich die Dokumentation wünschen? Du kannst ja nun auch einige Vorschläge machen.

Real Programmers don't draw flowcharts. Flowcharts are the illiterate's form of documentation. Cavemen drew flowcharts; look at how much good it did for them.

Dokumentation ist schoen und gut, aber um einen Datenfluss schnell verstehen zu koennen, inhaliere ich doch lieber eine Grafik und verstehe es innerhalb von Sekunden.

Du kannst dir die Dokumentation stattdessen zwei, drei mal durchlesen.

Edit: Mach daraus doch lieber vier oder fuenf.

...sondern auch beruflich für meine Nachfolger meine Dokumente hinterlassen muß.

na, dann gib' sie ihm doch einfach
digitalisierten kram zusammenzippen und papier, aufzeichnungen etc. in eine kiste - fertich. dafür gibt es keine standards.
hast du weder das eine, noch das andere, dann hat er eben pech gehabt (oder du, weil er dich dann längere zeit mit fragen löchern wird).