Einblicke · Dokumentation und Betrieb

Software braucht mehr als Quellcode.

Auch bei eigenen Produkten müssen Einrichtung, Betrieb und Weiterentwicklung nachvollziehbar bleiben. Die folgenden Punkte helfen, Wissen über eine Software dauerhaft zugänglich zu machen.

Kontakt aufnehmen

Quellcode und Nutzungsrechte

Legen Sie fest, welche Repositories und Bestandteile übergeben werden und welche Rechte Sie erhalten. Dazu gehören eigene Entwicklungen ebenso wie eine Übersicht über Fremdbibliotheken und deren Lizenzen.

Quellcode allein macht ein Produkt nicht unabhängig: Modelle, Cloud-Dienste und proprietäre Schnittstellen können weiterhin erforderlich sein. Diese Abhängigkeiten sollten mit Zweck und möglichen Wechselgrenzen dokumentiert sein.

Einrichtung und Dokumentation

Die Dokumentation sollte erklären, wie ein frischer Stand gebaut, konfiguriert und in der vereinbarten Umgebung gestartet wird. Erforderliche Versionen, Umgebungsvariablen und Datenstrukturen gehören dazu.

Ein praktisches Abnahmekriterium ist die Einrichtung anhand dieser Anleitung durch die übernehmende Seite. Dabei fallen fehlende Schritte oder stillschweigend vorausgesetzte Zugänge auf.

Konten, Zugänge und Kosten

Klären Sie, wem Hosting-, Modell- und weitere Dienstkonten gehören und wer Kosten trägt. Benennen Sie administrative Zuständigkeiten und einen sicheren Weg zur Übergabe erforderlicher Zugänge.

Geheimnisse gehören nicht in die normale Quellcode-Dokumentation. Nach der Übergabe müssen nicht mehr benötigte Zugriffe beendet und erforderliche Schlüssel nach dem vereinbarten Verfahren erneuert werden.

Tests, Grenzen und fachliche Abnahme

Testfälle sollten nicht nur den gelungenen Ablauf zeigen. Für KI-Software gehören fehlende Quellen, unpassende Eingaben, widersprüchliche Inhalte und unberechtigte Zugriffe dazu.

Halten Sie fest, was geprüft wurde, welche Einschränkungen verbleiben und wer die fachliche Verwendung freigibt. Eine Modell- oder Quellenänderung kann neue Tests erforderlich machen; die Abnahme eines Standes gilt nicht automatisch für jede spätere Version.

Daten und laufender Betrieb

Beschreiben Sie Speicherorte, Export, Löschung und – soweit für die Lösung nötig – Sicherung und Wiederherstellung. Dokumentieren Sie außerdem, wie Quellen aktualisiert und veraltete Inhalte aus dem Bestand entfernt werden.

Benennen Sie Verantwortliche für Störungen, Updates, Verbrauchskontrolle und fachliche Fragen. Diese Zuständigkeiten sollten auch bei eigenen Produkten ausdrücklich dokumentiert sein.

Checkliste für das Übergabegespräch

Lassen Sie sich die vereinbarten Punkte konkret zeigen:

  1. Der übergebene Stand lässt sich aus dem Repository bauen und starten.
  2. Konfiguration, Abhängigkeiten und Nutzungsrechte sind nachvollziehbar.
  3. Die vereinbarten Testfälle lassen sich erneut ausführen.
  4. Konten, Daten und notwendige Zugänge sind den Verantwortlichen zugeordnet.
  5. Fehlerfälle, bekannte Grenzen und Wiederanlauf sind dokumentiert.
  6. Abnahme, Restpunkte und Zuständigkeit für spätere Änderungen sind festgehalten.

Betrieb von Anfang an mitdenken

Die technische Umgebung und die Erfahrung der verantwortlichen Personen bestimmen, welche Dokumentation und Abläufe gebraucht werden. Das gehört bereits in die Produktplanung.