InnerWeb
Přejít na obsah

Dokumentace implementace systému: co má partner předat klientovi

Implementační partner, který předává klientovi srozumitelnou dokumentaci konfigurace, rolí a převzetí, mu dává důkaz při interním auditu a usnadňuje případnou změnu zhotovitele. Níže je soubor dokumentů a postupů, které se osvědčují.

5
dokumentů v doporučeném balíčku
Zdroj: osvědčené postupy InnerWeb
99,5%
dostupnost v údržbové smlouvě
Zdroj: návrh partnerské smlouvy

K čemu klientovi dokumentace partnera

Implementaci realizuje autorizovaný partner, který systém instaluje, konfiguruje a udržuje. Klient musí při interním auditu nebo kontrole umět ukázat, jak je systém nastaven, kdo má jaká oprávnění a kdy byla implementace převzata. Bez dokumentace závisí odpověď na paměti konkrétního inženýra partnera.

Partnerský model odděluje licenční smlouvu s výrobcem od implementační a údržbové smlouvy s partnerem. Dokumentace je proto důležitá i z pohledu kontinuity: když klient změní partnera, nový zhotovitel převezme údržbu na základě toho, co je zapsáno.

Rozsah dokumentů, které má partner předat

Doporučujeme pět základních dokumentů. Každý má jeden úkol a může být krátký, pokud je aktuální.

Popis konfigurace

Obsahuje nastavení modulů, map, zón, šablon oprávnění a notifikačních kanálů. Je dobré, když popisuje i důvody volby, nikoli jen hodnoty, protože to usnadňuje pozdější změny.

Matice rolí a oprávnění

Role v systému a matice oprávnění umožní nastavit přístup správců, ochrany, BOZP a koordinátorů externích firem bez změny kódu. Dokument by měl uvádět, která osoba má kterou roli, od kdy a kdo ji přidělil.

Popis integrace

Platforma poskytuje REST API (verze 1 a 2, autentizace JWT) a webhooky do platformy automatizace. Dokument popisuje, které systémy klienta jsou propojeny, jaké události se přenášejí a kdo je vlastníkem přístupového klíče na straně klienta.

Protokol o převzetí

Převzetí pilotu se opírá o předem dohodnutá měřitelná kritéria a trvá 3–6 měsíců. Protokol by měl obsahovat kritéria, výsledky testů, datum, podpisy oprávněných osob na straně klienta a partnera a připomínky k nápravě.

Údržbová smlouva a SLA

Obsahuje reakční a opravné časy, dostupnost 99,5% a pravidla pro snížení poplatku při překročení. Příkladová SLA z návrhu partnerské smlouvy: kategorie A reakce 12 hodin a oprava 8 hodin, kategorie B reakce následující den a oprava do 1 dne, kategorie C oprava do 7 dní.

Doba opravy v SLA podle kategorie hlášení

Doba opravy v SLA podle kategorie hlášeníVodorovný sloupcový graf: oprava 8, 24 a 168 hodin pro kategorie A, B a C050100150200hodinyKategorie AKategorie A: 8 hodiny8Kategorie BKategorie B: 24 hodiny24Kategorie CKategorie C: 168 hodiny168
Zdroj: Příkladová SLA z návrhu partnerské smlouvy (B: 1 den, C: 7 dní)

Auditní stopa jako doplněk dokumentů

Dokumenty popisují stav ke dni převzetí. Auditní stopa v systému zapisuje změny vybraných dat spolu s autorem a časem, což dává partnerovi důkaz provedené konfigurace při převzetí implementace. Když se auditor zeptá, lze ukázat nejen popis, ale i záznam změn.

Pořiďte snímek stavu konfigurace v den převzetí a přiložte jej k protokolu. Při pozdějších změnách ukáže auditní stopa rozdíl oproti tomuto stavu.

Rozdělení odpovědnosti v dokumentech

Dobrá dokumentace uvádí, kdo za co odpovídá: výrobce za software a licenci, partner za implementaci a údržbu, klient za síť a zdroje závodu. Pokud dokument nerozhodne, komu hlásit daný typ problému, utrpí doba reakce.

Do balíčku přidejte krátký návod pro hlášení poruch s kategoriemi A, B a C a kontaktními údaji pohotovostních osob na straně partnera. Kontaktní údaje veďte v samostatném dokumentu, který klient aktualizuje při změně osob.

Jak předejít typickým mezerám

Nejčastější mezery jsou zastaralá matice oprávnění po personálních změnách, chybějící popis integrace a chybějící podepsaný protokol o převzetí. Do údržbové smlouvy zapište každoroční kontrolu dokumentace a uveďte, kdo ji provede.

Kontrolní seznam

Videomateriál

Často kladené otázky

Musí být dokumentace v jednom souboru?

Ne. Důležité je, aby byl balíček úplný, aktuální a podepsaný oběma stranami. Může být veden v několika dokumentech.

K čemu slouží auditní stopa při převzetí?

Zapisuje změny vybraných dat spolu s autorem a časem, takže partner má důkaz provedené konfigurace.

Kdo dokumentaci uchovává?

Klient by měl mít vlastní kopii a partner pracovní kopii pro údržbu. Zapište to do údržbové smlouvy.

Připravme balíček dokumentů pro převzetí

Poskytneme vzor popisu konfigurace a protokolu o převzetí. Domluvte si rozhovor nebo demo.

Pojďme si promluvit