Wozu der Kunde die Dokumentation des Partners braucht
Die Umsetzung übernimmt der autorisierte Partner, der das System installiert, konfiguriert und wartet. Der Kunde muss bei einer internen Prüfung oder Kontrolle zeigen können, wie das System eingestellt ist, wer welche Berechtigungen hat und wann die Umsetzung abgenommen wurde. Ohne Dokumentation hängt die Antwort vom Gedächtnis einer bestimmten Fachkraft des Partners ab.
Das Partnermodell trennt die Lizenzvereinbarung mit dem Hersteller von den Umsetzungs- und Wartungsverträgen mit dem Partner. Die Dokumentation ist daher auch für die Kontinuität wichtig: Wechselt der Kunde den Partner, übernimmt der neue Auftragnehmer die Wartung auf Grundlage dessen, was festgehalten wurde.
Umfang der Dokumente, die der Partner übergeben sollte
Wir empfehlen fünf Grunddokumente. Jedes hat eine Aufgabe und darf kurz sein, sofern es aktuell ist.
Beschreibung der Konfiguration
Sie enthält die Einstellungen der Module, Karten, Bereiche, Genehmigungsvorlagen und Benachrichtigungskanäle. Hilfreich ist es, auch die Gründe für die Auswahl zu beschreiben und nicht nur die Werte, weil das spätere Änderungen erleichtert.
Matrix der Rollen und Berechtigungen
Die Rollen im System und die Berechtigungsmatrix erlauben, den Zugang von Administratoren, Werkschutz, Arbeitssicherheit und Koordinatoren von Fremdfirmen ohne Codeänderung einzurichten. Das Dokument sollte angeben, welche Person welche Rolle hat, seit wann und wer sie zugewiesen hat.
Beschreibung der Integration
Die Plattform stellt eine REST-API (Versionen 1 und 2, JWT-Authentifizierung) und Webhooks zur Automatisierungsplattform bereit. Das Dokument beschreibt, welche Systeme des Kunden verbunden sind, welche Ereignisse übertragen werden und wer auf Seiten des Kunden Inhaber des Zugangsschlüssels ist.
Abnahmeprotokoll
Die Abnahme des Pilotbetriebs beruht auf offen gelegten Kriterien und dauert 3–6 Monate. Das Protokoll sollte die Kriterien, Testergebnisse, das Datum, die Unterschriften der befugten Personen auf Seiten des Kunden und des Partners sowie Hinweise zur Nachbesserung enthalten.
Wartungsvertrag und SLA
Er enthält Reaktions- und Reparaturzeiten, eine Verfügbarkeit von 99,5% und die Regeln für die Minderung der Gebühr bei Überschreitungen. Beispiel-SLA aus dem Entwurf des Partnervertrags: Kategorie A Reaktion 12 Stunden und Reparatur 8 Stunden, Kategorie B Reaktion am nächsten Tag und Reparatur in 1 Tag, Kategorie C Reparatur in 7 Tagen.
Reparaturzeit im SLA nach Störungskategorie
Prüfpfad als Ergänzung der Dokumente
Die Dokumente beschreiben den Stand am Tag der Abnahme. Der Prüfpfad im System protokolliert Änderungen an ausgewählten Daten zusammen mit Autor und Zeitpunkt. So hat der Partner einen Nachweis der durchgeführten Konfiguration bei der Abnahme. Stellt ein Prüfer eine Frage, lässt sich also nicht nur die Beschreibung, sondern auch der Änderungsverlauf vorlegen.
Erstellen Sie am Tag der Abnahme einen Snapshot des Konfigurationsstands und legen Sie ihn dem Protokoll bei. Bei späteren Änderungen zeigt der Prüfpfad die Abweichung gegenüber diesem Stand.
Verantwortung in den Dokumenten klar trennen
Eine gute Dokumentation legt fest, wer wofür verantwortlich ist: der Hersteller für Software und Lizenz, der Partner für Umsetzung und Wartung, der Kunde für Netzwerk und Ressourcen des Werks. Wenn ein Dokument nicht festlegt, an wen ein bestimmter Problemtyp zu melden ist, leidet die Reaktionszeit.
Fügen Sie dem Paket eine kurze Anleitung zur Störungsmeldung mit den Kategorien A, B und C sowie den Kontaktdaten der Bereitschaftspersonen des Partners bei. Die Kontaktdaten führen Sie in einem eigenen Dokument, das der Kunde aktualisiert, wenn sich Personen ändern.
Wie typische Lücken vermieden werden
Die häufigsten Lücken sind eine veraltete Berechtigungsmatrix nach personellen Veränderungen, fehlende Beschreibung der Integration und ein fehlendes unterzeichnetes Abnahmeprotokoll. Nehmen Sie in den Wartungsvertrag eine jährliche Überprüfung der Dokumentation auf und halten Sie fest, wer sie durchführt.
Checkliste
Videomaterial
Häufig gestellte Fragen
Muss die Dokumentation in einer Datei liegen?
Nein. Wichtig ist, dass das Paket vollständig, aktuell und von beiden Seiten unterzeichnet ist. Es kann in mehreren Dokumenten geführt werden.
Wofür dient der Prüfpfad bei der Abnahme?
Er protokolliert Änderungen an ausgewählten Daten zusammen mit Autor und Zeitpunkt. So hat der Partner einen Nachweis der durchgeführten Konfiguration.
Wer bewahrt die Dokumentation auf?
Der Kunde sollte eine eigene Kopie haben, der Partner eine Arbeitskopie für die Wartung. Halten Sie das im Wartungsvertrag fest.
Bereiten wir das Dokumentenpaket für die Abnahme vor
Wir stellen Ihnen ein Muster der Konfigurationsbeschreibung und des Abnahmeprotokolls zur Verfügung. Vereinbaren Sie ein Gespräch oder eine Demo.
Sprechen wir