Hauptnavigation
Software aus Luzern Ideen werden Anwendungen.

Python-Tools

Python-Werkzeuge an den Betrieb übergeben

Machen Sie Ausführung, Fehlerbehandlung und Zuständigkeiten ohne Autorenwissen nachvollziehbar.

Eine kurze Betriebsanleitung erstellen

Beschreiben Sie Zweck, benötigte Eingaben, Startweg und erwartete Ausgaben. Ergänzen Sie Voraussetzungen, Zugriffsmöglichkeiten und die fachlich verantwortliche Person. Verwenden Sie konkrete Dateibeispiele mit erfundenen Inhalten. Die Anleitung muss erklären, woran ein erfolgreicher Lauf erkannt wird. Ein vorhandenes Ausgabedokument allein genügt nicht, wenn es auch aus einem früheren Lauf stammen könnte.

Fehlerwege und Grenzen dokumentieren

Nennen Sie häufige Fehlermeldungen, ihre Bedeutung und den zulässigen nächsten Schritt. Halten Sie fest, wann ein Lauf wiederholt werden darf und wann zuerst eine Prüfung nötig ist. Geben Sie eine betreute Anlaufstelle und eine Vertretung an. Beschreiben Sie auch bekannte Grenzen, damit neue Dateiformate oder zusätzliche Datenmengen nicht ungeprüft als unterstützter Betrieb gelten.

Die Übergabe praktisch abnehmen

Lassen Sie eine Person ohne Entwicklungsbeteiligung mit der Anleitung einen Beispielvorgang ausführen. Sie soll die Eingabe finden, den Lauf starten, das Ergebnis prüfen und einen vorbereiteten Fehler richtig einordnen. Sammeln Sie Stellen, an denen mündliche Hilfe nötig war, und ergänzen Sie die Anleitung. Die Übergabe ist abgeschlossen, wenn Zuständigkeit und wiederholbarer Betrieb tatsächlich funktionieren.

Direkt anwenden

  • Erfolg anhand aktuellen Ergebnisses prüfbar
  • Wiederholung und Eskalation klar beschrieben
  • Unbeteiligte Person führt Beispiel erfolgreich aus

Häufige Fragen

Reicht der Quellcode als Dokumentation?

Für den Betrieb braucht es zusätzlich den fachlichen Zweck und konkrete Handgriffe. Die Anleitung sollte bei Änderungen gemeinsam mit dem Werkzeug aktualisiert werden.

Ratgeber

Weitere Ratgeber