VBA-Dokumentation: Warum Ihr Excel-Tool sie braucht
Lesezeit: 6 Min. | Best Practices
Dokumentation wird oft ignoriert – bis der Entwickler das Unternehmen verlässt. Dieser Guide zeigt, wie Sie VBA-Tools wartbar dokumentieren.
Warum Dokumentation kritisch ist
- ❌ Entwickler verlässt Firma → Keiner versteht Code
- ❌ 6 Monate später → Selbst Entwickler versteht eigenen Code nicht
- ❌ Fehler auftreten → Debugging unmöglich
- ❌ Neue Features → Risiko alten Code zu brechen
Was dokumentiert werden sollte
1. Code-Kommentare
' === BERECHNUNG DER PROVISION ===
' Provision = 5% bei Umsatz < 10.000€
' Provision = 10% bei Umsatz >= 10.000€
' Letzte Änderung: 2025-10-15 (Max M.)
Function BerechneProvision(Umsatz As Double) As Double
If Umsatz < 10000 Then
BerechneProvision = Umsatz * 0.05
Else
BerechneProvision = Umsatz * 0.1
End If
End Function
2. README-Datei
Inhalt:
- Was macht das Tool?
- Systemanforderungen (Excel-Version, Add-Ins)
- Installation
- Erste Schritte
- Bekannte Probleme
- Kontakt bei Fragen
3. Changelog
# CHANGELOG ## Version 2.1.0 (2025-10-20) - NEU: Export nach PDF - FIX: Fehler bei leeren Zellen - VERBESSERT: Performance bei 10.000+ Zeilen ## Version 2.0.0 (2025-09-15) - NEU: Automatischer E-Mail-Versand - BREAKING CHANGE: Neue Spaltenstruktur erforderlich
4. Benutzer-Handbuch
Mit Screenshots:
- Schritt-für-Schritt-Anleitung
- Häufige Fragen (FAQ)
- Troubleshooting
Kommentare in VBA: Best Practices
Gute Kommentare:
' Berechnet Rabatt basierend auf Kundenkategorie (A=15%, B=10%, C=5%) Function GetRabatt(Kategorie As String) As Double
Schlechte Kommentare:
' Gibt Rabatt zurück Function GetRabatt(Kategorie As String) As Double
Template: Dokumentations-Vorlage
' ====================================
' MODUL: modDatenImport
' ZWECK: Import von CSV-Dateien
' AUTOR: Max Mustermann
' ERSTELLT: 2025-10-01
' LETZTE ÄNDERUNG: 2025-10-15
' ====================================
' ABHÄNGIGKEITEN:
' - Microsoft Scripting Runtime
' - FileSystemObject
' VERWENDUNG:
' Call ImportCSV("C:\Daten.csv")
' ====================================
Video-Tutorials aufnehmen
Kostenlose Tools:
- OBS Studio (kostenlos)
- Loom (kostenlos für 5min Videos)
- Windows Game Bar (Win + G)
Inhalt:
- 5-10 Minuten Walkthrough
- Häufigste Use Cases zeigen
- Typische Fehler demonstrieren
Fazit
Dokumentation ist Zukunftssicherung:
- ✅ Code verstehbar für Nachfolger
- ✅ Selbst nach Monaten wieder einsteigen
- ✅ Benutzer können Tool nutzen
- ✅ Support-Aufwand reduziert