Po co klientowi dokumentacja partnera
Wdrożenie realizuje autoryzowany partner, który instaluje, konfiguruje i utrzymuje system. Klient przy audycie wewnętrznym lub kontroli musi umieć pokazać, jak system jest ustawiony, kto ma jakie uprawnienia i kiedy odebrano wdrożenie. Bez dokumentacji odpowiedź zależy od pamięci konkretnego inżyniera partnera.
Model partnerski rozdziela umowę licencyjną z producentem od umów wdrożeniowej i utrzymaniowej z partnerem. Dokumentacja jest więc ważna także z perspektywy ciągłości: gdy klient zmieni partnera, nowy wykonawca przejmuje utrzymanie na podstawie tego, co zostało zapisane.
Zakres dokumentów, które powinien przekazać partner
Rekomendujemy pięć podstawowych dokumentów. Każdy z nich ma jedno zadanie i może być krótki, o ile jest aktualny.
Opis konfiguracji
Zawiera ustawienia modułów, mapy, strefy, szablony zezwoleń i kanały powiadomień. Dobrze, gdy opisuje także powody wyboru, a nie tylko wartości, bo ułatwia to późniejsze zmiany.
Macierz ról i uprawnień
Role w systemie i macierz uprawnień pozwalają skonfigurować dostęp administratorów, ochrony, BHP i koordynatorów firm zewnętrznych bez zmian w kodzie. Dokument powinien wskazywać, która osoba ma którą rolę, od kiedy i kto ją przydzielił.
Opis integracji
Platforma udostępnia API REST (wersje 1 i 2, uwierzytelnianie JWT) oraz webhooki do platformy automatyzacji. Dokument opisuje, które systemy klienta są połączone, jakie zdarzenia są przesyłane i kto jest właścicielem klucza dostępu po stronie klienta.
Protokół odbioru
Odbiór pilotażu oparty jest na jawnych kryteriach i trwa 3–6 miesięcy. Protokół powinien zawierać kryteria, wyniki testów, datę, podpisy osób upoważnionych po stronie klienta i partnera oraz uwagi do poprawy.
Umowa utrzymaniowa i SLA
Zawiera czasy reakcji i naprawy, dostępność 99,5% i zasady obniżenia opłaty za przekroczenia. Przykładowe SLA z projektu umowy partnerskiej: kategoria A reakcja 12 godzin i naprawa 8 godzin, kategoria B reakcja następnego dnia i naprawa w 1 dzień, kategoria C naprawa w 7 dni.
Czas naprawy w SLA wg kategorii zgłoszenia
Ślad audytowy jako uzupełnienie dokumentów
Dokumenty opisują stan na dzień odbioru. Ślad audytowy w systemie zapisuje zmiany wybranych danych razem z autorem i czasem, co daje partnerowi dowód wykonanej konfiguracji przy odbiorze wdrożenia. Dzięki temu w razie pytania audytora można pokazać nie tylko opis, ale też zapis zmian.
Zrób zrzut stanu konfiguracji w dniu odbioru i dołącz go do protokołu. Przy późniejszych zmianach ślad audytowy pokaże różnicę względem tego stanu.
Rozdzielenie odpowiedzialności w dokumentach
Dobra dokumentacja wskazuje, kto za co odpowiada: producent za oprogramowanie i licencję, partner za wdrożenie i utrzymanie, klient za sieć i zasoby zakładu. Jeśli dokument nie rozstrzyga, do kogo zgłosić dany typ problemu, ucierpi czas reakcji.
Dodaj do pakietu krótką instrukcję zgłaszania awarii z kategoriami A, B i C oraz danymi kontaktowymi dyżurnych po stronie partnera. Dane kontaktowe trzymaj w osobnym dokumencie, który klient aktualizuje, gdy zmieniają się osoby.
Jak uniknąć typowych luk
Najczęstsze luki to nieaktualna macierz uprawnień po zmianach kadrowych, brak opisu integracji i brak podpisanego protokołu odbioru. Wpisz do umowy utrzymaniowej coroczny przegląd dokumentacji i zapisz, kto go przeprowadza.
Lista kontrolna
Materiał wideo
Często zadawane pytania
Czy dokumentacja musi być w jednym pliku?
Nie. Ważne, by pakiet był kompletny, aktualny i podpisany przez obie strony. Można go prowadzić w kilku dokumentach.
Do czego służy ślad audytowy przy odbiorze?
Zapisuje zmiany wybranych danych razem z autorem i czasem, więc partner ma dowód wykonanej konfiguracji.
Kto przechowuje dokumentację?
Klient powinien mieć własną kopię, a partner kopię roboczą do utrzymania. Zapisz to w umowie utrzymaniowej.
Przygotujmy pakiet dokumentów odbioru
Podamy wzór opisu konfiguracji i protokołu odbioru. Umów rozmowę lub demo.
Porozmawiajmy