Wiedza o tym, jak działa środowisko IT, bywa w całości w głowie jednej osoby. To ryzyko, które ujawnia się przy urlopie, chorobie albo odejściu.
Co powinno być opisane
- spis serwerów i usług wraz z ich rolą,
- schemat sieci i połączeń z zewnątrz,
- lista dostawców z numerami umów,
- miejsce i sposób wykonywania kopii,
- procedury odtworzenia po awarii,
- gdzie leżą hasła i klucze.
Ostatni punkt wymaga zastrzeżenia: dokumentacja wskazuje miejsce i sposób dostępu, ale samych haseł nie zawiera. Te leżą w menedżerze haseł, a dokumentacja mówi, kto ma do niego wejście i co zrobić, gdy ta osoba jest nieosiągalna.
Poziom szczegółowości
Dokumentacja zbyt drobiazgowa nie jest aktualizowana. Wystarczy, żeby ktoś z zewnątrz mógł zrozumieć układ i odtworzyć działanie — reszta jest w konfiguracji.
Pomocna jest zasada: opisujemy decyzje i powiązania, nie ustawienia. Wartość pola w panelu da się odczytać z systemu, a powód, dla którego jest właśnie taka, nie da się odtworzyć znikąd. Zdanie wyjaśniające, dlaczego jeden serwis stoi osobno albo dlaczego integracja działa nocą, jest warte więcej niż dziesięć zrzutów ekranu.
Aktualizacja przy zmianie
Dokumentacja odświeżana raz w roku opisuje stan sprzed roku. Skuteczniejsze jest wymaganie aktualizacji jako części każdej zmiany w środowisku.
Część danych nie musi być pisana ręcznie. Spis maszyn, wersji i zainstalowanego oprogramowania pochodzi wprost z ewidencji sprzętu i oprogramowania i tam powinien pozostać. Dokumentacja odsyła do niego, zamiast go powielać — powielone zestawienia rozjeżdżają się zawsze.
Czym różni się od bazy wiedzy
Dokumentacja opisuje, jak zbudowane jest środowisko. Baza wiedzy odpowiada na pytania, które już padły. Pierwsza zmienia się przy zmianie infrastruktury, druga rośnie z każdym rozwiązanym zgłoszeniem. Trzymanie ich razem powoduje, że opis serwerów tonie wśród instrukcji resetu hasła.
Dostępność w kryzysie
Dokumentacja przechowywana wyłącznie w systemie, który właśnie padł, jest bezużyteczna. Kopia poza tym środowiskiem jest warunkiem jej sensu.
Sprawdza się prosty test: czy da się do niej dotrzeć z telefonu, bez sieci firmowej i bez logowania do usługi, która może być niedostępna. Wersja odświeżana automatycznie i trzymana w drugim miejscu rozwiązuje ten problem raz na zawsze.
Test praktyczny
Czy osoba, która nie zna środowiska, jest w stanie na jej podstawie odtworzyć kluczową usługę? Jeśli nie, dokumentacja jest opisem, nie narzędziem.
Najlepszą okazją do takiego sprawdzenia jest test odtworzenia z kopii zapasowych. Prowadzi go osoba, która nie budowała środowiska, wyłącznie na podstawie zapisanej procedury. Każde miejsce, w którym musiała zapytać, jest brakiem w dokumentacji i powinno zostać uzupełnione od razu po teście.
Kto to pisze
Jeśli środowisko utrzymuje firma zewnętrzna, dokumentacja powinna być częścią umowy i własnością zamawiającego, w formie, którą da się przekazać komuś innemu. Opis istniejący wyłącznie w narzędziach dostawcy nie chroni przed zależnością — przenosi ją tylko z jednej osoby na jedną firmę.
