Benutzerdefinierte Suche

Dokumentation und Softwareentwicklung

  1. Dinomo

    Dinomo Thread StarterMacUser Mitglied

    Mitglied seit:
    01.12.2004
    Beiträge:
    131
    Zustimmungen:
    1
    Hallo!

    Ich habe mal ein paar Fragen an die Entwickler unter Euch. Mich würde interessieren:
    1. Wie dokumentiert Ihr Programmentwicklungen?
    2. Wie macht Ihr das bei Entwicklungsteams?
    3. Welche Dokumentationssysteme setzt Ihr ein?
    4. Mit welchen SEU arbeitet Ihr und wie habt ihr evtl. die Dokumentationssysteme integriert?
    5. Wie haltet Ihr die Dokumentation aktuell und konsistent?
    6. Welche Probleme habt Ihr im Zusammenhang mit Programmentwicklungen und der Dokumentationserstellung?
    7. Wie ist eure persönliche Bereitschaft und Einstellung zur Dokumentation?
    8. Welche Probleme habt Ihr bei der Wartung und Weiterentwicklung von eigener oder fremder Software zu einem späteren Zeitpunkt mit der Dokumentation erlebt?

    Es würde mich freuen, wenn Ihr euch die Zeit nehmen würdet, die Fragen zu beantworten.

    Schonmal Danke im Voraus!

    Dinomo
     
    Dinomo, 25.03.2006
  2. below

    belowMacUser Mitglied

    Mitglied seit:
    15.03.2004
    Beiträge:
    13.289
    Zustimmungen:
    1.086
    Du willst aber ganz schön viel wissen. Warum?

    Ich dokumentiere im Code, wenn verlangt dann mit Doxygen oder Headerdoc.

    Alex
     
    below, 25.03.2006
  3. Master Pod

    Master PodMacUser Mitglied

    Mitglied seit:
    31.01.2005
    Beiträge:
    2.772
    Zustimmungen:
    14
    Vielleicht bekommst du Konkurrenz ;)


    MP
     
    Master Pod, 25.03.2006
  4. Dinomo

    Dinomo Thread StarterMacUser Mitglied

    Mitglied seit:
    01.12.2004
    Beiträge:
    131
    Zustimmungen:
    1
    Ist u.a. Bestandteil eines Referats im Wirtschaftsinformatik-Studium. Thema"Dokumentenverwaltung und Versionsmanagement in der Softwarepraxis".
     
    Dinomo, 25.03.2006
  5. pepperbob

    pepperbobMacUser Mitglied

    Mitglied seit:
    07.03.2006
    Beiträge:
    49
    Zustimmungen:
    0
    Ad 1: Prinzipiell basiert ein Großteil der Doku i.d.R. aus Inline Dokumentation. Aufgrund des zeitlichen Drucks, ist es praktisch schwer eine korrekte Dokumentation nebenbei zu führen.
    Ad 2: Jeder dokumentiert hier den Teil, den er gerade bearbeitet. Jeder Dokumentiert selbst, d.h. es gibt keine zentrale Sammelstelle.
    Ad 3: Wir haben desletzt konzeptionell versucht (bzw. versuchen immernoch) die Dokumentation z.T. über ein Wiki abzubilden. Dies hat den Vorteil, dass dadurch automatisch eine gewisse Historisierung der Doku gegeben ist und die Wiki Syntax macht die Sache auch schnell zu formatieren und leicht leserlich (Querverweise, Links, Suchfunktion, Kategorisierung etc.)
    Ad 4: Nichts besonderes. Prinzipiell ein Texteditor mit Syntaxhighlighting ohne Dokufunktion.
    Ad 5: Theoretisch wird jede Änderung sofort Dokumentiert, d.h. die Doku sollte damit immer aktuell sein.
    Ad 6: Problem 1 - Doku nimmt sehr viel Zeit ein. Problem 2 - Masse an "schneller" Inline Doku steigt damit. Problem 3 - Wiederauffinden v. Information erschwert
    Ad 7: Doku ist langweilig und zeitraubend (obwohl mir die Wichtigkeit der Doku bewusst ist)
    Ad 8: Durch mangelenden Umfang der Doku dauert die Einarbeit in fremdem Code enorm lang. Komplexe Programmkonstruktor können nur durch Zeile für Zeile lesen verstanden werden.
     
    pepperbob, 09.04.2006
  6. BalkonSurfer

    BalkonSurferMacUser Mitglied

    Mitglied seit:
    27.07.2003
    Beiträge:
    5.157
    Zustimmungen:
    1
    Dokumentation ist überflüssig, da sich das eh keiner durchliest.
    Inline-Doku ist kurz und schnell verfügbar, da man eh grad an der entsprechenden Codestelle ist.
    Jede Methode bekommt einen Kommantarheader mit genauer Beschreibung was rein geht und was raus geht sowie eine Kurzbeschreibung des Sinns.

    Im Code wird in 5-10er Blöcken beschrieben, was grad passiert. zb "Einlesen der Daten x und Verarbeitung durch Methodes x,y,z"

    Dann noch ein paar Schimpfwörter in die Doku, damit es aussieht, als wäre das richtig harter Tobak was man da macht und ein paar mal im Code ne Gehaltserhöhung fordern

    Das wars schon
     
    BalkonSurfer, 09.04.2006
  7. DeineMudda

    DeineMuddaunregistriert

    Mitglied seit:
    12.05.2005
    Beiträge:
    852
    Zustimmungen:
    72
    Huhu,

    ich bin Dipl.-Ing. und bei einem der größten IT-Dienstleister dieses Landes als Consultant tätig.

    Die Entwicklung erfolgt dort nach dem V-Modell, das bei IT-Projekten im Finanzsektor große Verbreitung hat.
    Dort ist auch die Art und Weise der Dokumentation definiert.

    Verwaltet wird das ganze (in diesem speziellen Fall) per CVS. Im V-Modell läuft das unter dem Thema "KM" (Konfigurationsmanagement) - dafür gibt es dann in jedem Projekt einen KM-Beauftragten, der z.B. für die Versionierung zuständig ist.

    Normalerweise gilt: Ein Stück Software ohne Dokumentation ist wertlos - allerdings wird in der Praxis (besonders) oft an dieser Stelle eingespart.

    Nachtrag: Vielleicht noch zur Größenordnung: Es werden Projekte >100MM abgewickelt.
     
    DeineMudda, 10.04.2006
  8. BalkonSurfer

    BalkonSurferMacUser Mitglied

    Mitglied seit:
    27.07.2003
    Beiträge:
    5.157
    Zustimmungen:
    1
    Wenn das die Telekom sein sollte, weiß ich, dass ich das V-Modell nie nie nie anwenden werde ;)
    Wo ich grad beim Thema bin, gleich mal gucken, was die Telekom heute an der ALGII Software versaut hat ;)
     
    BalkonSurfer, 10.04.2006
  9. firefoxuser

    firefoxuserMacUser Mitglied

    Mitglied seit:
    27.04.2005
    Beiträge:
    438
    Zustimmungen:
    1
    Ich dokumentiere fast alles in den source files also à la
    /*
    * diese function macht diesund das
    */

    außerdem werden sämtliche sachen nochmal ausführlicher in einer Lotus Notes datenbank gespeichert, die man sich dann mit dem team teilt ;-)
     
    firefoxuser, 11.04.2006
  10. DeineMudda

    DeineMuddaunregistriert

    Mitglied seit:
    12.05.2005
    Beiträge:
    852
    Zustimmungen:
    72
    Die "Telekom" heißt T-Systems und: Nein, sie ist es nicht.
     
    DeineMudda, 11.04.2006
Die Seite wird geladen...
Ähnliche Themen - Dokumentation Softwareentwicklung
  1. Bullz
    Antworten:
    3
    Aufrufe:
    440
  2. joecze
    Antworten:
    4
    Aufrufe:
    591
  3. FunkyMusic
    Antworten:
    2
    Aufrufe:
    605
    FunkyMusic
    17.07.2008
  4. Maverick_85
    Antworten:
    4
    Aufrufe:
    613
  5. helgeh
    Antworten:
    0
    Aufrufe:
    765
Benutzerdefinierte Suche