AUTO-DOKUMENTATION VON CODES

Ziel von SPF Consulting ist es, die Wirtschaftlichkeit von IT-Systemen und Organisationen über den gesamten Lebenszyklus durch umfassende Leistungen in der Software Entwicklung nachhaltig zu steigern. Dazu entwickelt das Delivery Team von SPF Consulting Tools für die Bereitstellung und Automatisierung von Testdaten und arbeitet tatkräftig in Kundenprojekten mit. Dem Delivery Team von SPF ist es besonders wichtig, stets langfristige Qualität zu liefern und mittels agiler Vorgehensweisen auf Kundenwünsche eingehen zu können.

Schlechte, fehlerhafte oder veraltete Dokumentation erschwert dir das Leben? Du findest es mühsam, dass es nicht einen einfacheren Weg gibt die Dokumentation mit in den Entwicklungsprozess mit einzubeziehen? Versuch dich an unserer Challenge und mach nicht nur dein eigenes Leben, sondern auch das von zahlreichen anderen Entwicklern einfacher! So kannst du dich in unserer Community unsterblich machen!

KONTEXT UND HINTERGRUND

Die technische Dokumentation ist ein unabdinglicher Bestandteil für eine gute Codebasis. Gute Dokumentation besteht aus der richtigen Mischung von Code Kommentaren, ReadMes, Schnittstellenbeschreibungen und JavaDoc (und anderen). Beispielhafte Konsequenzen durch schlechte oder nicht vorhandene Dokumentation:

  • Verlust der Wartbarkeit bzw. Weiterentwicklungsfähigkeit
  • Ineffiziente Serviceleistung erhöht Kosten und Ausfallzeiten
  • Erschwerter Know-How Transfer
  • Schlechtes Onboarding von neuen Entwicklungs-Teammitgliedern

Jeder will eine gute Dokumentation, aber eben…

BESCHREIBUNG DES PROBLEMS

Obwohl die Dokumentation unbestritten einer der wichtigsten Bestandteile einer guten Codebasis ist, wird sie oftmals vernachlässigt und als Nebensächlichkeit behandelt. Fehlende, falsche, halb-wahre oder veraltete Dokumentation machen ein grosses Projekt oft undurchsichtig und erschweren ein effizientes Arbeiten.Die Auswirkungen wie Waste, Mehraufwand und viel Frust sind einige Konsequenzen -du kennst sicherlich noch andere Auswirkungen.

ANFORDERUNGEN AN DIE LÖSUNG

Um diese Probleme zu beheben, braucht es wohl eine toolunterstütze Lösung, welche uns Entwicklern einfach und bequem das Dokumentieren von Code unterstützt oder dies zu gewissen Teilen übernimmt. Ob z.B. mittels Gamification während des Programmierens oder als Analyse-Tool, welches vor jedem Commit die Codebase überprüft – der Umsetzung sind keine Grenzen gesetzt.

Folgende Lösungs-Visionen könnten wir uns vorstellen:

  • Vielleicht schreibst du ein Plugin für deine IDE, welches automatisch Alter und Vollständigkeit von Dokumentationen erfasst?
  • Vielleich schreibst du ein IDE-Ergänzung, welche dem User direkt ein Docu-Tasks präsentiert, um den Entwickler von nerviger Fleissarbeit zu entlasten
  • Oder du entwickelst gar einen neuen Weg, um Code automatisch zu dokumentieren?

Deine Lösung sollte einer der folgenden Punkte adressieren:

  • Zeitersparnis beim Dokumentieren
  • Erhöhte Wartbarkeit (mehr und aktuellere Doku)
  • Höherer Nutzen (z. B. erweiterter Leserkreis, mehr Spass)