Eure favorisierte Form der Dokumentation

[Daniel]

Tach auch,



manch einer von Euch klickt ja nicht nur in der DP herum, sondern programmiert ja nebenbei auch noch. Unter Umständen sogar mit Kollegen.
Mich würde mal interessieren, was sich da bei Euch als effizienteste Form der Dokumentation herauskristallisiert hat. Sei es Dokumentation, die fokussiert ganz konkret einzelne Aspekte Eurer Projekte adressiert oder auch Dokumentation, die das "Große Ganze" beschreibt und die Zusammenhänge zwischen den diversen Bestandteilen bzw. Modulen.

Ich kenne Firmen, die erfolgreich mit Word und Excel arbeiten, andere legen sich ein Wiki an. Manche Dokumentationsprojekte funktionieren, andere driften vom Projekt ab und schaffen so eine vielleicht lustige, aber nutzlose Parallelwelt.
Was hat bei Euch gut funktioniert?


Vorrangig bin ich an Praxisberichten interessiert - weniger an Euren Vorstellungen, warum Methode X oder Y Eurer Ansicht nach nicht funktionieren kann.

[dummzeuch]

Ich habe Wikis bei zwei Jobs ausprobiert, aber ich bin anscheinend der einzige, der sie praktisch findet und/oder in der Lage ist, darin Artikel zu schreiben. Funktioniert hat eigentlich immer nur Word (oder OpenOffice), reine Textdateien und Uebersichtsbilder (mit yEd).

Eine etwas abwegige Art der Dokumentation sind fuer mich meine Blog-Posts. Solange keine Firmeninterna davon betroffen sind, finde ich es ganz gut, wenn ich mir selbst auf diese Art eine Gedaechtnisstuetze gebe und nebenbei vielleicht auch anderen helfe. Z.B. diese hier:

http://blog.dummzeuch.de/2015/04/27/...-tar-archives/

http://blog.dummzeuch.de/2015/04/09/...ndows-service/

[Lemmy]

wir verwenden gerade auch ein Wiki, wobei ich dummzeuchs bestätigen kann: Es gibt nur sehr wenige die Input liefern, noch weniger die sich im Wiki informieren. Wenn aber inzwischen Fragen bei mir landen kann ich die oft über einen entsprechenden Link ins Wiki einfach beantworten - deshalb werde ich auf dem Weg erst mal weiter machen.

Office Dateien bin ich ganz schnell wieder weg gekommen, da in kürzester Zeit unterschiedliche Versionen im Umlauf waren...

[vagtler]

Wir verwenden sowohl für unsere internen Produkte als auch für alle externen Projekte ein Enterprise-Wiki mit integrierten Google Docs zur Dokumentation. Das hat sich für uns als effizienteste Art der Kollaboration erwiesen.

[Bernhard Geyer]

Ich denke es kommt immer auf die Art der Dokumentation an.

Benutzerhandbücher, Pflichtenheft, ...: Word-Dokument das als PDF zum Kunden gesendet wird.
Interne Dokumentation die auch mal "Formlos" erfolgt: Wiki. Dazu haben wir mittlerweile Confluence (https://www.atlassian.com/software/confluence)
Dan natürlich für Problemfälle/Fehler/Anforderungen/User Strories/ gibts Jira.

Punkt 2 und 3 lassen sich schön miteinander Verknüpfen und können auch direkt mit dem Kunden zusammen mit "Leben" gefüllt werden.
Gegenüber früher werden weniger Excellisten/Word-Dokumente oder Mails ausgetauscht.

[BUG]

Ich sehe gerade den Ablauf in einem akademischen Projekt, wobei mir die internen Releases mit dazugehörigen Architekturdokumenten gefallen. So ein Dokument zwingt einen im Großen ab und zu ein konsistentes Bild zusammenzutragen und lesbar auszuformulieren. Ist natürlich aufwendig.