VBA Projektdokumentation

[StrammerMax]

Hey Leute,

ich habe in den letzten Wochen mein erstes größeres Projekt mit VBA umgesetzt.

Ich habe vieles ausprobiert, bis ich eine Lösung gefunden habe, die funktioniert. Dabei ist der Code nach und nach gewachsen, wurde immer wieder verändert und umfasst nun knapp 10.000 Zeilen Code.

Das ganze ist relativ chaotisch aufgebaut, hat wenig bis keine Kommentare und ist weit von einem professionellen Niveau entfernt.

Nun muss ich zu diesem Projekt eine Dokumentation anlegen, damit Dritte (die sich überhaupt nicht mit VBA auskennen) im Notfall das erstellte Tool warten können.

Ich selbst verstehe teilweise jetzt schon nicht mehr was der Code macht... wie soll ich 10.000 Zeilen so dokumentieren, dass ein Laie das versteht?

Gibt es hier jemanden, der professionell mit VBA arbeitet und mir einen Tipp / eine Vorlage geben kann, mit der man solche Projekte dokumentieren kann?

[Klaus-Dieter]

Hallo Max,

Hinweise hinsichtlich deiner Quelltexte hast du ja genug bekommen. Im Nachhinein so etwas zu optimieren und eine Dokumentation zu erstellen, ist natürlich ein Problem. Wie man dabei helfen kann, weiß ich nicht. Wenn ich lese, dass du da rund 10000 Zeilen Quelltext hast, kann ich dir sagen, dass da sicher einiges falsch gelaufen ist. In über zwanzig Jahren habe ich hunderte von Quelltesten geschrieben, auch für komplexe Anwendungen. Da ist keiner dabei, der auch nur annähernd so lang geworden ist.
Diese Hinweise werden dir sicher nicht wirklich weiter helfen, aber nun liegt das Kind im Bach, wer soll es für dich rausholen?

[Elex]

Hi

dokumentieren

Wenn das nicht gleich beim erstellen des Codes mit erledigt wird ist es kein Vergnügen.

ob dir das jetzt noch hilft?
https://www.clever-excel-forum.de/thread-19319.html

Gruß Elex

[snb]

Du solltest die Code erstmals reduzieren.('streamlining')
Dann wird dokumentieren auch 'etwas' einfacher

[Sulprobil]

Hey Leute,

ich habe in den letzten Wochen mein erstes größeres Projekt mit VBA umgesetzt.

Ich habe vieles ausprobiert, bis ich eine Lösung gefunden habe, die funktioniert. Dabei ist der Code nach und nach gewachsen, wurde immer wieder verändert und umfasst nun knapp 10.000 Zeilen Code.

Das ganze ist relativ chaotisch aufgebaut, hat wenig bis keine Kommentare und ist weit von einem professionellen Niveau entfernt.

Nun muss ich zu diesem Projekt eine Dokumentation anlegen, damit Dritte (die sich überhaupt nicht mit VBA auskennen) im Notfall das erstellte Tool warten können.

Ich selbst verstehe teilweise jetzt schon nicht mehr was der Code macht... wie soll ich 10.000 Zeilen so dokumentieren, dass ein Laie das versteht?

Gibt es hier jemanden, der professionell mit VBA arbeitet und mir einen Tipp / eine Vorlage geben kann, mit der man solche Projekte dokumentieren kann?

Hallo,

Ich erstelle normalerweise zu jedem VBA Projekt zwei (Word) Dokumente:
Eine Systemdokumentation (wie man die Anwendung installiert und parametriert)
Ein Benutzerhandbuch (wie man die Anwendung verwendet)

Diese Dokumente kannst Du sicherlich auch im Nachhinein erstellen, bei einer kleinen Anwendung ggf. mit 2 Kapiteln in einem Dokument.

Plane etwas mehr Zeit ein, um ggf. Teile Deines Codes umzuschreiben.

Ein etwas ketzerischer Rat wäre: Falls kein VBA Könner bei Deinem ersten größeren VBA Projekt einen Code Review durchgeführt hat, wirf Deinen Code weg und fang von vorn an. Mit einem Mentor.

Viele Grüße,
Bernd P

[StrammerMax]

Ein Projekt zeichnet sich bekanntlich durch ein fest definiertes Ende aus. Da dieses Ende recht nah liegt und ich nicht 24/7 Zeit für dieses Projekt habe ist "wegwerfen und neu machen" keine Option.
Auch gibt es bei mir im Unternehmen niemanden, der sich mit VBA so gut auskennt, dass er meinen Code reviewen könnte.

D.h. ich muss mit dem zurecht kommen, was vorhanden ist.

Die 10.000 Zeilen sind Teilweise auch redundant (mehrere Optionen mit dem gleichen Code). Mir ist bewusst, dass ein Profi den Code mehrfach verwendet und ihn nicht mehrfach geschrieben / kopiert hätte. Aber so ist es jetzt nun mal.
Wenn man den redundanten Code abzieht gibt es ca. 3.500-4.000 Zeilen.

Ich weiß schon noch grob, was welche Codeabschnitte machen. Aber ich habe keine Ahnung wie ich das verbal beschreiben soll.
Beschreibe ich jede einzelne Funktion mit Parametern und Funktionalität?
Oder beschreibe ich grundlegend, was der Code auf einem Arbeitsblatt macht?

Und selbst wenn ich jede Funktion einzeln beschreibe wird ein Laie der sich nicht auskennt damit nichts anfangen können.
Es gibt viel zu viele Abhängigkeiten untereinander.

Funktionen, die nur funktionieren oder ausgeführt werden, wenn andere Bedingungen erfüllt sind.

Zudem haben Änderungen im Code teilweise gravierende Auswirkungen. Da ich von Anfang an alles ohne Namen, mit festen Zuweisungen von Zeilen implementiert habe würde es alles zerschießen, wenn jemand auch nur eine Zeile löscht oder hinzufügt.

Mir ist bewusst, dass das alles andere als professionell ist - allerdings ist das Projekt wie anfangs erwähnt immer weiter gewachsen. Und zu dem Zeitpunkt zu dem ich realisiert habe, dass Namen essentiell gewesen wären war ich schon so weit, dass ein komplettes neu Aufsetzen des Codes im gesetzten zeitrahmen unmöglich war.

[snb]

Erspare dich die Mühe: ein Laie kann es nicht verstehen und ein Profi verweigert es zu lesen und fängt eben nicht an Spaghetti-code zu ändern.

[Sulprobil]

Hallo,

Ich würde allgemein beschreiben, wie man die Anwendung installiert und wie eine normale Ausführung läuft.
Dazu dann "regelmäßige" Sonderfälle:
Neue Einträge,
Neuer Kunde,
Neue Filialen,
Neue User,
Neue Berichte,
etc.
Auch als Hinweise im Code.

Viele Grüße,
Bernd P

[StrammerMax]

@snb mir ist bewusst, dass ich der Einzige bin der dieses Tool warten kann.

Wenn der Chef aber nach einer Dokumentation verlangt muss ich ihm auch eine liefern - unabhängig davon, wie sinnvoll das ist.

Wenn es schon nicht dazu dient dass es wirklich jemand versteht sollte es zumindest einen professionellen Eindruck machen / visuell professionell aussehen.

[StrammerMax]

Hallo,

Ich würde allgemein beschreiben, wie man die Anwendung installiert und wie eine normale Ausführung läuft.
Dazu dann "regelmäßige" Sonderfälle:
Neue Einträge,
Neuer Kunde,
Neue Filialen,
Neue User,
Neue Berichte,
etc.
Auch als Hinweise im Code.

Viele Grüße,
Bernd P

Vielen Dank, das hilft mir weiter.
Solche konkreten Anwendungsfälle könnte ich natürlich beschreiben.