Dokumentationen?

MagicJojo · #1 08.02.2010, 15:22

Hi Kollegen,

wer kennt das nicht: Man entwickelt Software, IT-Infrastrukturen oder sonst etwas und möchte ein paar Monate oder Jahre später die ganze Geschichte erweitern bzw. ändern. Einmal in der Dokumentation geblättert und schon hat man die Stellen gefunden, die man dazu editieren muss.

In manchen Betrieben gehört die Doku zum Alltag, bei anderen wieder nicht. Wie steht Ihr zu dem Thema? Bitte abstimmen und wenn Möglich auch kommentieren ;-)

Ihr habt auch ein Recht auf meine Meinung

Ich persönlich finde, dass das Gröbste immer dokumentiert gehört. Aus diesem Grund hab ich ein Wiki aufm lokalen Server installiert und da kommt jeder Mist rein, der irgendwie mal notwendig war.

Liebe Grüße
MagicJojo

Armadillo · #2 08.02.2010, 15:32

Also ich muss sagen, dass wir bis vor kurzem gar nicht dokumentiert haben, was ein großer Fehler ist. Wir bekommen einfach immer mehr Kunden und dadurch immer mehr Server und Dienste und wir verlieren schlicht und einfach den Überblick. Früher konnte sich jeder bei allem merken wie was funktioniert hat etc.
Das funktioniert aber nur bis zu einem gewissen Punkt. irgendwann bilden sich Experten für bestimmte Themen und ab diesem Zeitpunkt muss man dokumentieren für den Fall, dass der Experte nicht da, krank oder sonst was ist.
Deshalb haben wir uns jetzt ebenfalls ein kleines internes Wiki aufgesetzt, das auch gut angenommen und stetig erweitert wird. man glaubt gar nicht, was man so alles nebenher macht, was andere gar nicht wissen.

HxD · #3 08.02.2010, 15:34

Wir Dokumentieren ebenfalls, bin aber absolut kein Freund davon, vorallem nicht von der Projektdokumentation... Als Mediengestalter ist man da wirklich richtig am Arsch...

So mit der beschissenste Aspekt meines Berufes

traced · #4 08.02.2010, 15:35

Welches Wiki verwendet Ihr denn hierfür?

Grüsse
Basti
(der leider zu wenig dokumentiert...)

MagicJojo · #5 08.02.2010, 15:54

Interessante Beiträge :-)

Hätte nicht erwartet, dass das ein Thema ist, auf das alle irgendwie ähnlich sensibel reagieren. Manchmal ist es Zeitdruck, manchmal vielleicht auch Faulheit, dass die Dokus hinten bleiben... Ist denke ich mal bei keinem anders (bei mir auch nicht).

Ich nutze MediaWiki zum dokumentieren. Das finde ich ganz praktisch, vor allem wenn mehrere Leute daran arbeiten sollen. Und man kann gut zurück verfolgen, wann wer was geändert hat.

Ich bin selbst auch zweigespalten, zum Einen gehe ich Richtung Fachinformatik (Systemintegration) und zum Anderen in Richtung Medien- und Webdesign. Ich hab mich mit meinen Nerven darauf geeinigt, dass ich das IT-Zeug voll dokumentieren möchte, aber bei Medien-/Webdesign nur das, was der Kunde später allein (ohne meine Hilfe) übernehmen soll.

HxD · #6 08.02.2010, 16:14

Zitat:

Zitat von MagicJojo

...Anderen in Richtung Medien- und Webdesign. Ich hab mich mit meinen Nerven darauf geeinigt, dass ich das IT-Zeug voll dokumentieren möchte, aber bei Medien-/Webdesign nur das, was der Kunde später allein (ohne meine Hilfe) übernehmen soll.

Genau das ist das Problem... Stell dir vor, du bastelst ein CMS oder passt ein Layout an ein anderes CMS an, welches du dafür speziell umschreiben musst bspw. Typo3 / Typolight... Jetzt passiert es, das der Kunde - weswegen auch immer - zugriff auf die Daten hat und die Seite schrottet, oder etwas wichtiges nach ein paar Monaten / Jahren geändert haben möchte [ Quellcode Änderung ] und du sitzt nun vor deinem angepassten CMS oder selbstgeschriebenem CMS und yo, dann haste nen Problem

Das sind zumindestens meine Erfahrungen, die ich in der Thematik bislang hatte, vorallem bezogen auf CMS ANPASSUNGEN... Schreckliches Thema -.-

Armadillo · #7 08.02.2010, 16:20

Zitat:

Zitat von traced

Welches Wiki verwendet Ihr denn hierfür?

http://www.dokuwiki.org/dokuwiki

MagicJojo · #8 08.02.2010, 16:23

Ich find MediaWiki besser

(Achtung, Trollgefahr)

Armadillo · #9 08.02.2010, 16:33

http://www.wikimatrix.org/
Man suche sich die die auf die eigenen Anforderungen am besten passt raus.

traced · #10 08.02.2010, 16:39

Zitat:

Zitat von Armadillo

http://www.wikimatrix.org/

Danke!

*10zeichen*

Ben. · #11 08.02.2010, 17:11

Bei uns wird auch alles dokumentiert. Zum einen bezahlt der Kunde dafür und zum anderen macht es auch absolut Sinn Änderungen / Entwicklungen zu dokumentieren.

Ich habe dennoch angekreuzt dass es mich nervt, denn das tut es. Du arbeitest an einem Problem, denkst drüber nach und schraubst an 1000 Stellen bis es funktioniert, musst aber gleichzeitig alles dokumentieren was du machst, auch wenn du es wieder rückgängig machst.

Das nervt.

Aber ich bin sehr froh auf alte Dokumentationen von mir / meinen Kollegen zugreifen zu können.

Abgesehen von Prozessdokus sind aber auch Code-Dokus extrem wichtig wie ich finde. Anstrengend wird es für Aussenstehende wenn es um Abkürzungen geht. "Der FB generiert eine SA die für die GZ relevant wird => Wird gelinkt auf VS".

MagicJojo · #12 08.02.2010, 17:35

Und genau das finde ich so gut an dynamischen Wikis. Anstatt wieder umständlich auf irgendwelche anderen Dokudateien zu vermerken einfach ein [[...]] außenrum kleben und schon macht die Wikisoftware einen Link daraus. Auch wenn man irgendwelche Seiten später mal verschiebt, wird automatisch alles angepasst. Vorlagen kann man auch verwenden :-)

Firewire2002 · #13 08.02.2010, 18:44

Wir dokumentieren auch. Geht auch gar nicht anders.
Viele Systeme haben Besonderheiten, die man sich auf Dauer einfach nicht merken kann.

Davon abgesehen hilft es auch eine Übersicht über das Inventar zu bekommen. Soll ja in diversen Unternehmen schon Fälle gegeben haben, in denen nach Jahren Server aufgetaucht sind, die nirgends mehr vermerkt waren.

Das dokumentieren manchmal nervend ist und man eigentlich "besseres" machen könnte, ist wohl normal.

Dokumentiert wird auf mehreren Wege, hauptsächlich aber übers Wiki (Confluence).

Ben. · #14 08.02.2010, 20:03

@Firewire: Wie ist Confluence so?

Firewire2002 · #15 08.02.2010, 20:21

Geht das etwas präziser?

Mal davon abgesehen, dass es eine geschlossene Java Anwendung ist. Gefällt mir Confluence recht gut. Viele Funktionen, lassen sich bei Bedarf auch erweitern.
Aber das wichtigste was ich daran schätze, ist der automatische Bau von Menüstrukturen. Ich kann es nicht begreifen, warum kein einziges freies CMS mal hinbekommt, automatisch, aus der Seitenhierarchie heraus ein ordentliches Menü zu bauen. Bei einigen kann mans zwar mit paar Modulen/Plugins reinfrickeln, aber ich hab bisher keins gefunden, dass es so ordentlich wie Confluence kann.

Ansonsten Seiten können via RichText Editor oder klarer Wiki Syntax bearbeitet werden. Multiuser Betrieb mit AD Anbindung sind auch kein Problem.

Es ist eben ein Enterprise Wiki.

Ich hoffe die Antwort war schwimmig genug für die unpräzise Frage.