Dokumentationen?

Dokumentieren?

  • Ja, bei uns wird dokumentiert, und es ist auch gut so.

    Votes: 14 60.9%
  • Ja, bei uns wird dokumentiert, aber der zusätzliche Zeitaufwand nervt mich.

    Votes: 6 26.1%
  • Nein, bei uns wird nicht dokumentiert, und wir hatten auch nie Bedarf an Dokus.

    Votes: 1 4.3%
  • Nein, bei uns wird nicht dokumentiert, ich würde es aber trotzdem befürworten.

    Votes: 2 8.7%

  • Total voters
    23

MagicJojo

Registered User
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 :D 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

Registered User
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. ;)
 
H

HxD

Guest
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 :D
 

traced

Registered User
Welches Wiki verwendet Ihr denn hierfür?

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

MagicJojo

Registered User
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.
 
H

HxD

Guest
...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 :D

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

Ben.

Registered User
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

Registered User
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

Registered User
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. :p
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).
 

Firewire2002

Registered User
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. :p
 

Ben.

Registered User
Mir ging es um den persönlichen Eindruck, und den kriegt man eben durch eine solch unpräzise Frage, war demnach absolut Absicht :) So hast du mir das gesagt, was dir als erstes in den Sinn kam :)

Technische Features finde ich auf der Webseite.

Danke für deine Hilfe.
 

dev

Registered User
Ich arbeite mit Subversion für alle Projekte, da bekommt man auch schonmal einen Überblick über die Änderungen und kann auch mit anderen Leuten verteilt arbeiten.

Daneben läuft hier viel über eine Projektmanagement-Software, die ich für Serveradministrationsdokumentation und andere Anleitungen "missbrauche".

Wikis finde ich generell sehr unübersichtlich. Teilweise findet man Seiten nicht wieder, da man nirgendwo einen "Seitenbaum" hat.
 

Firewire2002

Registered User
da man nirgendwo einen "Seitenbaum" hat.
Siehe meinen Kommentar zu Confluence. ;)

"nirgendwo" trifft es nicht ganz. Das Problem tritt merkwürdigerweise nur bei freien Wikis auf. Bei allen kommerziellen Lösungen gabs dazu immer irgendwo eine Funktion. :)
 

Armadillo

Registered User
Wikis finde ich generell sehr unübersichtlich. Teilweise findet man Seiten nicht wieder, da man nirgendwo einen "Seitenbaum" hat.
Jo, das ist der Grund warum ich Wikis grundsätzlich nicht leiden kann. Aber wenn man sich an gewisse Regeln hält und einen Index anlegt geht es eigentlich. Wird nur ausufernd wenn das Wiki viel größer wird.
 

Huschi

Moderator
Staff member
Zu dem Thema könnte ich jetzt ein halbes Buch schreiben... ;)
"Dokumentation" ist ein recht vielfältiger Begriff.
Allein hier wurden schon drei unterschiedliche Fälle von Dokus aufgeführt:
Server, Projekt, Software.
Dazu gesellt sich Pflichten-/Lastenheft (ja, auch das ist eine wichtige Doku), eine Installationsanleitung und ein Bedienungshandbuch.
Und für jeden Entwickler ist so ziemlich alles dieser Arte eine totale Last. ;)
Richtig lästig wird es, wenn man verschiedene Dokus in einem Dokument zusammen bringen muss.

Am liebsten nutze ich formatunabhängige ASCII-Texte. :D
Da ich aber in verschiedenen Projekten Wiki's nutzen muss kann ich noch Folgendes sagen:
DokuWiki finde ich für sowas besser als MediaWiki.
Allein weil DokuWiki mit Dateien auskommt ist es schneller mal gedumpt oder umgezogen.
Aber auch von den Text-Formatierungen komme ich damit besser klar.

huschi.
 
Top