+ Antworten
Seite 1 von 2 1 2 LetzteLetzte
Ergebnis 1 bis 15 von 25

Wie dokumentiert ihr euren Quellcode bzw. bearbeitete Tickets

Diskussion über Wie dokumentiert ihr euren Quellcode bzw. bearbeitete Tickets in IT-Arbeitswelt der Kategorie Ausbildung/Job; Tja, ich denke die Frage ist gar nicht so schwierig, allerdings wird das bei uns das Thema seit jeher stiefmütterlich ...

  1. #1
    Reg.-Benutzer
    Reg.-Datum
    29.05.2010
    Beiträge
    697

    Standard Wie dokumentiert ihr euren Quellcode bzw. bearbeitete Tickets

    Tja, ich denke die Frage ist gar nicht so schwierig, allerdings wird das bei uns das Thema seit jeher stiefmütterlich behandelt. Bei vielen Firmen wird gar nicht dokumentiert, bei uns findet eher eine wildwüchsige Überkontrolle statt.

    Der Entwickler bearbeitet bei uns ein Ticket in der Reklamationserfassung und trägt es dort als erledigt mit Kommentar ein. Danach schreibt er einen Eintrag für das Anwenderprotokoll (also was der Anwender bei neuen Versionen erhält) und einen Eintrag für das Developerprotokoll (für den Tester). Dazu macht er noch einen Eintrag in der Zeiterfassung, was er gemacht hat. Außerdem gibt der Entwickler nochmal mündlich Rückmeldung und gegebenenfalls muss er auch dem Kunden nochmal Bescheid geben. Darüber hinaus muss natürlich der Quellcode kommentiert werden.

    Es sind also für jede(!) noch so banale Änderung am Programm an 3 bis 5 Stellen Kommentare zu hinterlassen. Ich finde das unheimlich umständlich, zeitaufreibend und es wird von mir daher meist nur lückenhaft durchgeführt, weil eine zentrale Stelle zur Dokumentation fehlt. Ich habe wirklich kein Problem meine Tätigkeiten zu dokumentieren, aber wenn es in Schikane ausartet, dann läuft etwas falsch.

    Wie macht ihr das? Benutzt ihr JIRA, OTRS, Polarion oder dergleichen? Führt ihr die Ticket-Nr. im Quellcode mit? Werden die Protokolle für ein Release automatisch durch das Ticketsystem oder Bug-Tracking-System generiert? Gibt es eine Integration mit der Versionsverwaltung? Wird der Lebenszyklus einer Softwareänderung tatsächlich auch informationstechnisch abgebildet?

    Am liebsten würde ich unser jetziges System auf links ziehen. Ich würde einfach gerne wissen, wie das bei anderen so abläuft.

  2. #2
    Reg.-Benutzer
    Reg.-Datum
    05.04.2009
    Beiträge
    549

    Standard

    Für Tickets die unsere Entwicklung betreffen: MantisBT
    Quellcode wird auch direkt kommentiert (also im Code, nicht irgendwo außerhalb)

    Zeiterfassung ist bei uns keine Vorgabe, das würde mich persönlich auch stören.

    Dazu muss ich aber sagen, dass wir inhouse tätig sein, d.h. unsere Kollegen sind unsere "Kunden"
    ZWNobyAiSGVsbCB5ZWFoLCBiYXNlNjQiIHwgYmFzZTY0ClNHVn NiQ0I1WldGb0xDQmlZWE5sTmpRSw==

  3. #3
    Reg.-Benutzer
    Reg.-Datum
    02.02.2011
    Beiträge
    696

    Standard

    Bei uns können Mantis und die Zeiterfassung miteinander. Wenn eine Tätgkeit also ticketbezogen war, wird nur die Ticketnummer eingetragen.
    Wäre auch ausbau- und verbesserungsfähig.

  4. #4
    Reg.-Benutzer
    Reg.-Datum
    29.05.2010
    Beiträge
    697

    Standard

    Ja, grundsätzlich bin der Meinung, dass Einträge im Bug-Tracking-System (bei uns: Reklamationserfassung) auch als Einträge in der Zeiterfassung angesehen werden sollten. Man könnte dort auch direkt Plan- und Ist-Aufwände eintragen und damit dann eben Kalkulationen anstellen (z.B. Aufwand für ein Release, Abweichungen in der Planung).

    In der Zeiterfassung wird nicht das gleiche eingetragen wie im Bug-Tracking-System, sondern eher als Zusammenfassung. Man könnte auch per Copy&Paste arbeiten, aber das ist natürlich trotzdem sehr lästig und ganz einfach überflüssig (zumal Reklamationserfassung und Zeiterfassung ohnehin in einem Programm vereint sind).

  5. #5
    Reg.-Benutzer
    Reg.-Datum
    05.01.2008
    Ort
    Leipzig
    Beiträge
    919

    Standard

    Neben den Kommentaren im Quellcode nutzen wir git und übergeben die dortigen commit-Kommentare an bugzilla als Bugtracker.
    Demnächst wird eine ähnliche Anbindung von auch zu otrs entstehen.

    Gruß Martin
    Dieser Texte kann Spuren von Ironie, Sarkasmus, Denkanstössen und freier Meinungsäusserung enthalten. Es wird keine Garantie auf Textverständnis gewährleistet. Bei Risiken und Nebenwirkungen lesen Sie bitte zwischen den Zeilen, oder denken Sie einfach nicht weiter darüber nach.

  6. #6
    Reg.-Benutzer
    Reg.-Datum
    29.05.2010
    Beiträge
    697

    Standard

    Wie wird das übergeben? Werden die Kommentare in einem bestimmten Format (javadoc o.ä.) angegeben und dann durch ein Tool in den Bugtracker rübergeschaufelt? Wird dazu die Ticket-Nr. im Quellcode hinterlegt?

  7. #7
    Reg.-Benutzer
    Reg.-Datum
    05.01.2008
    Ort
    Leipzig
    Beiträge
    919

    Standard

    @gimbo
    wir haben ein selbstgestricktes Script, das git-commit der Form: Bugfix: 4711 Text
    erkennt und damit den Bug 4711 auf erledigt setzt und "Text" als Erledigungskommentar im Bugzilla einträgt
    Direkte Zugriffe auf den Code bzw. Kommentare im Code erfolgen hierbei nicht.

    Gruß Martin
    Dieser Texte kann Spuren von Ironie, Sarkasmus, Denkanstössen und freier Meinungsäusserung enthalten. Es wird keine Garantie auf Textverständnis gewährleistet. Bei Risiken und Nebenwirkungen lesen Sie bitte zwischen den Zeilen, oder denken Sie einfach nicht weiter darüber nach.

  8. #8
    Reg.-Benutzer
    Reg.-Datum
    08.01.2012
    Beiträge
    111

    Standard

    Zitat Zitat von gimbo Beitrag anzeigen
    Der Entwickler bearbeitet bei uns ein Ticket in der Reklamationserfassung und trägt es dort als erledigt mit Kommentar ein.
    Reklamationserfassung ?

    Danach schreibt er einen Eintrag für das Anwenderprotokoll (also was der Anwender bei neuen Versionen erhält)
    Das sind Informationen die direkt für den Kunden/User gedacht sind ?
    Dazu bietet sich ein entsprechendes Changelog-File direkt in der Codebase an
    (daraus kann man ja andere Dokumente automatisch generieren).

    und einen Eintrag für das Developerprotokoll (für den Tester).
    Informationen die für den Tester sind, würde ich grundsätzlich im Ticket
    erfassen, bevor es an den Tester weitergegeben wird. Dieser sollte dann
    auch bei Bedarf entsprechend die Testpläne anfassen.

    Die Changes im VCS sollten jeweils in sich konsistent sein (also genau eben
    ***NICHT*** einmal pro Tag oder vor der Pause committen !) und den Zweck
    der Änderung kurz und knapp beschreiben.

    Dazu macht er noch einen Eintrag in der Zeiterfassung, was er gemacht hat.
    Gehört ins Ticket.

    Außerdem gibt der Entwickler nochmal mündlich Rückmeldung und gegebenenfalls muss er auch dem Kunden nochmal Bescheid geben.
    Für sowas gibts doch Ticketsysteme.

    Darüber hinaus muss natürlich der Quellcode kommentiert werden.
    Ja, aber bitte Doxygen-Kompatibel und nur die wichtigen Dinge,
    die nicht ohnehin selbsterklärend sind.

    Ahja, und die Änderungen kommentiert man nicht im Sourcecode,
    sondern im VCS.


    Es sind also für jede(!) noch so banale Änderung am Programm an 3 bis 5 Stellen
    Kommentare zu hinterlassen. Ich finde das unheimlich umständlich, zeitaufreibend
    Und vorallem enorm teuer !

    Benutzt ihr JIRA, OTRS, Polarion oder dergleichen?
    hmm, da gäbs auch noch Redmine, Trac, Bugzilla.

    Führt ihr die Ticket-Nr. im Quellcode mit?
    In der commit-Message im VCS, damit man das dann automatisch
    verknüpfen kann. Aber *NICHT* im Sourcecode.

    Werden die Protokolle für ein Release automatisch durch das Ticketsystem
    oder Bug-Tracking-System generiert?
    Unterschiedlich. Hängt stark von der Projektgröße und der Release-Dichte ab.

    Gibt es eine Integration mit der Versionsverwaltung?
    Jain. Ich habe bisher noch keine Toolumgebung gesehen, die alle
    benötigten Workflows direkt abbilden konnte. Ergo muß man sich
    da vieles Projektspezifisch selbst zusammenstellen/-bauen.

  9. #9
    Reg.-Benutzer
    Reg.-Datum
    02.02.2011
    Beiträge
    696

    Standard

    Die Changes im VCS sollten jeweils in sich konsistent sein (also genau eben
    ***NICHT*** einmal pro Tag oder vor der Pause committen !) und den Zweck
    der Änderung kurz und knapp beschreiben.
    Mal blöd gefragt: Wärs dann nicht besser, ein "nur mal zwischendurch Commit" entsprechend zu taggen? Die entsprechenden Commits könnte man dann bei weiterer Bearbeitung ignorieren?

    Die Vorgehensweise mit den Ticketnummern im VCS und daran verknüpft die Änderungen im Sourcecode zu finden, wäre noch ausbaufähig... es gibt für VS eine SVN-Anbindung. Man könnte direkt für verschiedene Commits oder eine Gruppe von Commits (z.B. alle mit Ticketnummer xy oder mit Projekt abc verknüpften) Farben definieren, so dass auch im Sourcecode direkt zusammengehörige Änderungen farblich hintelegt sind. Das würde auch einen Überblick über mehrere commits hinweg erleichtern.

  10. #10
    Reg.-Benutzer
    Reg.-Datum
    29.05.2010
    Beiträge
    697

    Standard

    Gut, damit kommen wir der Sache näher. Wir nennen unser eigenes Bug-Tracking-System eben Reklamationserfassung. Im Prinzip ist das aber nur eine elektronische Liste mit Fehlern und Wünschen, in der man als Support-Mitarbeiter oder Entwickler Kommentare hinterlassen kann und bei den einzelnen Vorgängen am Ende einen Haken mit "erledigt" setzt.

    Das ist also recht rudimentär und daher sagte ich, dass meist auch noch eine mündliche Weitergabe des Bearbeitungsstatus' erfolgt. Ich kann als Entwickler eben nicht vernünftig mitteilen, ob eine Änderung nun getestet werden kann oder ob ich den Fehler reklamiere (z.B. weil ich ihn nicht nachvollziehen kann). Der Lebenszyklus eines Änderungswunsches lässt sich mit einem einzelnen Haken "erledigt" einfach nicht abbilden.

    Wir haben keine Versionsverwaltung. Ich nutze zwar für mich selbst SVN auf meinem Rechner, aber das ist kein unternehmensweiter Standard. Demzufolge kann ich die Kommentarfunktion bei den Commits auch nicht wirklich nutzen, das wäre nur wieder eine zusätzliche Kommentarmöglichkeit. Das Fass Versionsverwaltung will ich lieber nicht angehen, das ist wieder ein eigenes Thema. Allein die Einführung eines Bug-Tracking-Systems wäre schon eine Herausforderung für sich. Weniger wegen der zu ändernden organisatorischen Abläufe als viel mehr wegen der fehlenden Unterstützung in der Geschäftsleitung.

  11. #11
    Reg.-Benutzer
    Reg.-Datum
    02.02.2011
    Beiträge
    696

    Standard

    Zitat Zitat von gimbo Beitrag anzeigen
    als viel mehr wegen der fehlenden Unterstützung in der Geschäftsleitung.
    Dann werden wohl auich logische und/oder finanzielle Argumente nicht helfen?

  12. #12
    Reg.-Benutzer
    Reg.-Datum
    29.05.2010
    Beiträge
    697

    Standard

    Nicht fakturierbare Aufträge werden halt nicht so gern gesehen.

    Für die Anpassungen an der bestehenden "Reklamationserfassung" wurde 1 Tag eingeräumt. Ich halte das für Quatsch, weil man mit einem Tag vielleicht ein paar Kleinigkeiten verbessern kann, aber keine nennenswerte Effizienzsteigerung erreicht. Aus meiner Sicht müssten wir die Software in die Tonne hauen und uns ein System wie JIRA näher anschauen. Warum soll man das nachprogrammieren, was andere schon gut gelöst haben? Ein Tag wäre allein für die Evaluation der geeigneten Tools schon sehr knapp.

  13. #13
    Reg.-Benutzer
    Reg.-Datum
    02.02.2011
    Beiträge
    696

    Standard

    Zitat Zitat von gimbo Beitrag anzeigen
    Nicht fakturierbare Aufträge werden halt nicht so gern gesehen.
    Die IT und Entwicklung ist bei Euch nicht Hauptabteilung, sondern eher eher Mittel zum Zweck? Wie groß seid Ihr denn (sprich, wie hierarchisch und bürokratisch läuft alles bei Euch ab)? Ihr habt keine QM?
    Man könnte zur Optimierung der Arbeitsprozesse, der Qualitäts- und Effizienzsteigerung, und damit auch Kostensenkung, eine generelle Umstrukturierung vornehmen, die ein Arbeiten ermöglicht, wie es den aktuellen Standards entspricht.

  14. #14
    Reg.-Benutzer
    Reg.-Datum
    29.05.2010
    Beiträge
    697

    Standard

    ca. 10 Personen (inkl. Auszubildende). Wir sind eine Softwarefirma. QM gibt es nicht. Das Thema ist zwar seit einiger Zeit immer wieder im Gespräch seitens der Geschäftsleitung, aber ich sehe bei dieser ablehnenden Haltung gegenüber echten Fortschritten eher schwarz. Leider wird seit ich hier bin (6 Jahre) so gut wie nichts in die eigenen Prozesse investiert und ich habe den Verdacht, dass dieser Zustand noch deutlich weiter zurückgeht. Es ist halt grotesk, dass wir von den eigenen Kunden erwarten, dass sie ihre Geschäftsprozesse an unsere Software anpassen, wir aber bei der Modernisierung unserer eigenen Prozesse eine erstaunliche Hüftsteifigkeit zeigen. Veränderung heißt bei uns, dass wir darüber nachdenken ob wir nicht noch irgendwo eine zusätzliche Excel-Liste einführen können oder ob wir irgendwo ein Datenfeld mit einem Standardwert vorbelegen können. So kommt es natürlich mit der Zeit zu einem "Reformationsstau".

    Nun ja, ich denke ich bin an dieser Stelle ausreichend auf meine Beweggründe eingegangen.

  15. #15
    Reg.-Benutzer Avatar von H0ff1
    Reg.-Datum
    12.01.2012
    Ort
    Bayern
    Beiträge
    20

    Standard

    Also für Ticketerstellung/ -bearbeitung benutzen wir unsere eigens entwickelte Software.
    Haben wir ein Ticket abgeschlossen, setzen wir es auf den Status 'gelöst' und schreiben - bei Bugs - kurz rein, was den Fehler verursacht hat.
    Und ansonsten noch bestimmte Hinweise für die QA zum testen, falls nötig.

    Die Ticketnr. mit Titel des Tickets schreiben wir dann immer eine Changelog-Datei im Projekt und beim committen ins SVN das gleiche nochmal als Kommentar. So sieht man schneller, was im commit drin war.

    Kommentare im Quellcode sind bei uns nicht unbedingt Pflicht. Wenn eben Code kommt der irgendwie besonders ist, oder kompliziert zu verstehen ist, sollte der halt kommentiert sein, damit der nächste auch weiß was da passiert, ohne ewig zu schauen.

    Läuft so eigentlich einwandfrei kann mich nicht beklagen

Aktive Benutzer

Aktive Benutzer

Aktive Benutzer in diesem Thema: 1 (Registrierte Benutzer: 0, Gäste: 1)

     

Ähnliche Themen

  1. Ausbildungsnachweise: Müssen Sport und Religion auch dokumentiert werden?
    Von Maddin007 im Forum Ausbildung im IT-Bereich
    Antworten: 9
    Letzter Beitrag: 09.12.2011, 08:13
  2. Antworten: 0
    Letzter Beitrag: 18.02.2010, 15:36
  3. Tickets FC Barcelona
    Von mhel im Forum Daily Talk
    Antworten: 4
    Letzter Beitrag: 26.08.2006, 19:58
  4. Standardfehler Präsi: hiermit dokumentiert
    Von giftclown im Forum Abschlussprojekte
    Antworten: 6
    Letzter Beitrag: 21.06.2005, 15:11
  5. Womit dokumentiert ihr ?
    Von Jogo im Forum Networking Technologies
    Antworten: 2
    Letzter Beitrag: 11.09.2001, 09:26

Die häufigsten Suchbegriffe für diese Seite:

fachinformatiker gimbo fix