Foren » 34. BwInf

Überarbeitung der Dokumentation

    • 10 Beiträge
    2. Februar 2016 22:24:29 CET
    Gegeben den Fall, dass bei der Erstellung der Dokumentation man viel Zeit in die Beschreibung einer Lösung, sowie deren Implementierung investiert hat. Auf einmal bemerkt man, das die mühselig gelöste Aufgabe eine bessere Lösung mit z.B. geringerer Zeitkomplexität hat. Diese bessere Lösung basiert in ihren Ideen zumindest Teilweise in denen der bereits beschriebenen Lösung.
    Sollte man in so einem Fall die alte Dokumentation überschreiben, oder aber sie als mögliche Lösung stehen lassen und die Optimierung hinzufügen?
    • 2 Beiträge
    3. Februar 2016 21:31:41 CET
    Also wenn deine neue Lösung stark auf der alten basiert, dann würde ich einfach die Optimierung hinzufügen.
    Nur wenn die neue Lösung sich zu stark von der alten unterscheidet, dann macht es wohl eher Sinn den Teil neu zu schreiben. Das hängt vor alem davon ab ob es wirklich nur eine Optimierung ist, oder der Ansatz schon etwas anders ist, in welchem Fall man die neue Lösung schon etwas genauer erklären sollte.
    Du kannst aber ja vielleicht trotzdem auch deine alte Lösung kurz erläutern und dann erklären warum sie nicht so gut und deine neue besser ist.
    • 10 Beiträge
    3. Februar 2016 21:40:28 CET
    Dankeschön, das hilft mir schonmal weiter :)
    Bedenken habe ich eigentlich nur wegen eventuellen Abzügen, wenn ich bei der Dokumentation ein Verfahren ausführlich schildere, das ich am Ende gar nicht so verwende.
    • 391 Beiträge
    3. Februar 2016 22:49:02 CET
    Es wäre wohl komisch, wenn man zuerst eine Lösung beschreibt und dann sagt: Ätsch, war nix, jetzt kommt erst die richtige Lösung.
    Wenn aber die schlussendlich gefundene Lösung auf einer zwischenzeitlich ausgearbeiteten Lösung basiert, kann es interessant sein, diese Entwicklung zu schildern und auch die Gründe, warum man bei der ursprünglichen Lösung nicht stehen geblieben ist. Die eigene Arbeit kritisch zu sehen und verbessern zu können, ist durchaus eine wichtige Eigenschaft.

    Es sollte natürlich immer sehr deutlich sein, welche Lösung nun die endgültige und maßgebliche ist.