KI-gestütztes VS-Code Plug-in
Ein innovativer Ansatz zur Wissenssicherung in der Softwareent-wicklung
Die Dokumentation von Quellcode ist entscheidend für Wartung, Wissenstransfer und Teamarbeit wird jedoch im Alltag häufig vernachlässigt. Das Diplomarbeitsprojekt VoiceDoc setzt genau hier an: Mit einem KI-gestützten Plug-in für Visual Studio Code soll die Kommentierung direkt per Spracheingabe vereinfacht und automatisiert werden. Ziel ist es, die Dokumentationsqualität zu erhöhen, ohne den Entwicklungsfluss zu unterbrechen.
VoiceDoc – Automatisierte Code-Dokumentation per Spracheingabe
Mit VoiceDoc wird die Dokumentation von Quellcode direkt im Editor deutlich vereinfacht. Das KI-gestützte Plug-in für Visual Studio Code erlaubt es Entwicklerinnen und Entwicklern, per Spracheingabe erklärende Kommentare zu ihrem Code zu erstellen und genau dort, wo sie gerade arbeiten. Die Lösung unterstützt unterschiedliche Kommentarformate (//, #, Docstrings etc.) und kann sowohl lokal mit Whisper (Offline-Modus) als auch cloudbasiert über Azure Speech genutzt werden. Ziel ist es, Wissenssicherung „im Moment der Entstehung“ zu ermöglichen, Übergaben zu vereinfachen und die Codequalität zu verbessern.
Die Herausforderung
In Softwareprojekten ist unzureichend dokumentierter Code ein häufiges Problem und insbesondere bei Übergaben, Onboarding neuer Teammitglieder oder bei Audits. Manuelle Kommentierung wird oft vernachlässigt, da sie als zusätzlicher Aufwand empfunden wird. VoiceDoc adressiert dieses Problem, indem es Sprachkommentare direkt in verständliche, formatierte Textbausteine übersetzt und automatisiert in den Code einfügt.
Ziel
Das Tool soll eine möglichst einfache, schnelle und konfigurierbare Möglichkeit zur Codekommentierung bieten. Dazu unterstützt es mehrere Programmiersprachen, arbeitet plattformübergreifend und lässt sich ohne Serverinstallation direkt über den VS-Code-Marktplatz nutzen. Während der Testphase wurde ergänzend ein ChatGPT-API-Key zur Bewertung und Optimierung der Kommentarqualität verwendet.
Wie funktioniert VoiceDoc?
Audioaufnahme: Die Aufnahme erfolgt per Hotkey. Voice Activity Detection sorgt dafür, dass nur relevante Sprache verarbeitet wird.
STT-Verarbeitung: Je nach Modus wird die Spracheingabe mit Whisper (Offline) oder Azure (Cloud) transkribiert.
Kommentarformatierung: Der erkannte Text wird in das passende Kommentarformat umgewandelt, je nach Programmiersprache.
Einbettung im Code: Die Kommentare erscheinen direkt an der Stelle, an der sie diktiert wurden.
Konfiguration und Sicherheit: API-Keys werden sicher im VS-Code-Secret-Store gespeichert; alle Datenverarbeitungen im Offline-Profil bleiben lokal.
Fazit
VoiceDoc hat gezeigt, dass sich Sprachsteuerung produktiv in Entwicklungsumgebungen integrieren lässt. Besonders hervorzuheben sind die einfache Bedienung, die Flexibilität zwischen Cloud- und Offline-Modus sowie die konfigurierbare Anpassung an Teamstandards. Für Entwicklerteams mit hohem Dokumentationsbedarf oder komplexen Codebasen bietet das Tool einen messbaren Produktivitätsgewinn.
Azad Ahmed
Ich habe die Ausbildung zum dipl. Techniker HF Informatik an der TEKO Olten angefangen. Während meiner beruflichen Laufbahn habe ich mich besonders für Softwareentwicklung und KI-gestützte Lösungen interessiert. Die Diplomarbeit VoiceDoc vereint
azad.ahmed@edu.teko.ch
