Wie dokumentiert man am besten Änderungen

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Antworten
mzh
User
Beiträge: 295
Registriert: Dienstag 3. März 2009, 15:27
Wohnort: ZH

Freitag 16. März 2012, 11:49

Liebes Forum
Wie dokumentiert man am besten Änderungen in einer Implementation? Angenommen ich habe ein Modul, welches ich für Hilfsfunktionen benötige. Immer wieder füge ich eine neue Funktion hinzu, bzw. ändere eine alte. Wie dokumentiere ich am besten (für mich selbst) solche Änderungen? Theoretisch müsste ja zu jeder Funktion ein Log geführt werden. Wie macht ihr das?

Danke für Hinweise.
[url=http://www.proandkon.com]proandkon.com[/url]
deets

Freitag 16. März 2012, 11:50

Ich benutze grundsaetzlich ein VCS - heutzutage git oder mercurial. Und dann schreibst du halt commit-messages, und kannst dir die als log anzeigen lassen.
mzh
User
Beiträge: 295
Registriert: Dienstag 3. März 2009, 15:27
Wohnort: ZH

Freitag 16. März 2012, 11:57

Kann man auch mit einem Projekt, dass mittlerweile in fortgeschrittenem Stadium ist, noch in ein VCS einsteigen?
[url=http://www.proandkon.com]proandkon.com[/url]
deets

Freitag 16. März 2012, 12:00

natuerlich, kann man immer und jederzeit. du bekommst natuerlich nicht automatisch eine bearbeitungs-historie... ich wuerde auch unabhaengig von der doku-frage *immer* dazu raten, ein VCS zu benutzen. es kostet dich nix, und rettet dir den allerwertesten, wenn du durch allerlei missgeschicke deinen code verbaselst oder verbastelsts. von definierten releases, bugfix-branches usw mal ganz abgesehen. und noch besser ist natuerlich ein remote repository, als backup.
mzh
User
Beiträge: 295
Registriert: Dienstag 3. März 2009, 15:27
Wohnort: ZH

Freitag 16. März 2012, 12:01

jetzt weiss ich endlich was ich am wochenende machen will.
[url=http://www.proandkon.com]proandkon.com[/url]
Antworten