Dokumentacja systemów IT - dlaczego warto mieć ją zawsze aktualną?

1. Wstęp

Dobrze utrzymywana Dokumentacja Systemów IT jest jedną z istotniejszych rzeczy. Stanowi źródło wiedzy, jakie systemy w danej organizacji działają i jakie są zależności między nimi. W tym artykule skupimy się na zasadach tworzenia dokumentacji raz jej aktualizacji. Cały temat zostanie pokazany z naszej perspektywy, a więc firmy świadczącej usługi informatyczne na rzecz innych firm w relacji B2B. Oczywiście jest to nasz punkt widzenia, a inne firmy mogą do tego podchodzić inaczej.

Dokumentacja systemów IT (dobra i aktualna, a tylko taka ma sens) powinna być elementem wiedzy o danej organizacji - ze specjalnym naciskiem na słowo POWINNA, ponieważ z doświadczenia wiemy, jak to zazwyczaj wygląda. Dokumentacja albo jest, albo jej nie ma. Jak jest, to zazwyczaj nieaktualna i prowadzona nierzetelnie.

Dlatego wszędzie tam, gdzie się pojawiamy, wprowadzamy dobrą praktykę utrzymywania aktualnej dokumentacji systemu IT. Wykorzystujemy do tego ogólnodostępne narzędzia, a dostęp do dokumentacji oczywiście jest otwarty dla kadry zarządzającej danej organizacji. Wszystkie elementy dokumentacji są przetwarzane i przechowywane w formie elektronicznej. Najczęściej wykorzystywanym przez nas systemem jest wiki.js .

2. Co powinna zawierać dobra dokumentacja?

2.1 Schemat logiczny infrastruktury IT

Podstawy podstaw - schemat logiczny. Schemat powinien zawierać wszystkie elementy infrastruktury IT zgodnie z zasadą - od ogółu do szczegółu. Ciężko zmieścić wszystko na jednej stronie nawet formatu A3 (w PDF oczywiście). W bardziej skomplikowanych instalacjach, dobrze jest rozbić schemat na części. Najpierw schemat ogólny, następnie uszczegółowione kolejne elementy systemu. Istotne jest również to, aby schemat zawierał połączenia między elementami infrastruktury np. połączenie między budynkami światłowodem lub skrętką UTP.

Do schematu powinna powstać legenda, która opisuje poszczególne elementy. Dobry schemat pozwoli szybko zorientować się, jak są połączone poszczególne elementy systemu i jak ze sobą współdziałają. Dzięki temu można też planować rozbudowę oraz modernizację. Do tworzenia wszelkiego rodzaju schematów można z powodzeniem wykorzystać “draw.io” - darmowy system do tworzenia różnego rodzaju schematów - również z branży IT.

2.2 Opis wraz ze schematem połączeń w szafach rack

W dobrej Dokumentacji Systemu IT nie może zabraknąć schematu połączeń w szafach RACK. Każde gniazdko w patchpanelu powinno być oznaczone przyjętym schematem oznaczeń. Ważne, aby w razie potrzeby można było szybko ustalić, co jest włączone do gniazdka i gdzie dane urządzenie znajduje się w organizacji. Jest to pomocne przy wszelkiego rodzaju przepięciach i pracach serwisowych oraz awariach.

Przykład wykorzystania: Ze względów serwisowych należy wymienić jeden z uszkodzonych switchy - występuje problem z jednym z portów. Dzięki wiedzy, ile i jakie urządzenia są podłączone do tego switcha, można ocenić skalę przestoju i odpowiednio wcześniej poinformować danych użytkowników o planowanych pracach serwisowych. Można to oczywiście wykonać również po godzinach pracy …

2.3 Opis systemów informatycznych

Dobrą praktyką jest opisanie pokrótce działających systemów informatycznych: aplikacje, bazy danych, serwery aplikacyjne - czyli co gdzie jest zainstalowane. Warto również spisać, pod jakimi nr IP dane usługi pracują. Można to zrobić np. w postaci tabeli.

2.4 Spis wszystkich serwerów wraz z nr IP

Kolejną sprawa to spis wszystkich serwerów wraz z ich lokalizacją: gdzie serwer jest zlokalizowany, jaki ma nr IP, jakie usługi świadczy, model serwera, do kiedy ma ważną umowę serwisową etc.

2.5 Spis wszystkich przełączników (switchy)

Spis urządzeń powinien zawierać również spis wszystkich switchy: model, producent etc. Przydaje się np. przy inwentaryzacji lub planowaniu nowych zakupów.

2.6 Opis istotnych rozwiązań zastosowanych w organizacji

Warto również opisać pokrótce istotne rozwiązania IT działające w organizacji np.:

• system zintegrowany “Fosmos”: księgowość, kadry, środki trwałe etc.
• system elektronicznego obiegu dokumentów “Karteczka”: system wykorzystywany w elektronicznym obiegu dokumentów, wbudowany mechanizm obsługi skanerów etc.
• telefonia VoIP oparta o PBX Asterix: własna centralka PBX, obsługa nr wewnętrznych i zewnętrznych
• System “Drukarz” do zarządzania drukarkami sieciowymi: do drukowania wykorzystuje się system “Drukarz”, do którego drukują poszczególne stanowiska, następnie “Drukarz” drukuje na wybranej drukarce. System służy do nadzoru drukowania w firmie.

2.6 Procedury IT “Disaster Recovery”

Warto również mieć zatwierdzone procedury IT “Disaster Recovery” czyli “Odtworzenie systemów IT po katastrofie” zatwierdzone przez właściciela lub kadrę zarządzającą. Opisanie możliwych ryzyk, ich wpływu na organizację oraz procedury, które zostaną uruchomione w przypadku zaistnienia sytuacji krytycznej.

Dobre przygotowanie sprawi, iż w przypadku nagłego zdarzenia, będzie wiadomo co robić i jakie zasoby użyć, aby zminimalizować skutki awarii. Istotne również jest to, aby procedury “Disaster Recovery” testować co jakiś czas. Testy dadzą nam odpowiedź, czy w przypadku zaistnienia danego zdarzenia organizacja jest w stanie po zastosowaniu ustalonych procedur funkcjonować normalnie lub w zaakceptowanym ograniczonym zakresie, do czasu całkowitego usunięcia przyczyny i skutków niekorzystnego zdarzenia.

3. Sposoby tworzenia dokumentacji

Tutaj też są różne szkoły. Niektórzy tworzą dokumentację w systemach wykorzystywanych do zarządzania zasobami IT, inni tworzą ją np w plikach typu MS Office, jeszcze inni tworzą dokumentację w systemach typu wiki (dostęp przez stronę WWW).

My do tworzenia dokumentacji wykorzystujemy różne narzędzia, zależy wszystko od wielkości danej organizacji. Preferujemy systemy typu wiki np. wiki.js - tam opisujemy wszystkie kluczowe aspekty danego środowiska IT.

Założenie zawsze jest takie samo, dostęp do dokumentacji powinien być zawsze możliwy. Więc dobrze jest ją mieć w co najmniej dwóch miejscach.

4. Dla kogo właściwie jest taka dokumentacja?

Przede wszystkim dla:

1. Dla kadry zarządzającej, właścicieli - po zapoznaniu się, mają wiedzę, z czego tak naprawdę składa się ich system IT. A z doświadczenia możemy powiedzieć, iż czasami sami się dziwią, co mają …

2. Dla nas, jako dla firmy, która dba o system IT w danej organizacji ciężko jest wszystko zapamiętać - co gdzie i jak, a dobra dokumentacja pozwala sobie szybko przypomnieć … i szybko zadziałać.

3. Dla nowego pracownika - tak, po odejściu doświadczonego pracownika i zatrudnieniu nowego, należy go wprowadzić w specyfikę danej organizacji, studiowanie lektury z dokumentacją IT to pierwszy krok do zdobycia wiedzy, o nowym środowisku pracy.

4. Dla nowej firmy … cóż z czasem współpraca się kończy z pewnych powodów. Dokumentacja zostaje (firma obsługiwana za nią przecież zapłaciła) i dla nowej firmy, która rozpoczyna opiekę serwisową, dokumentacja pozwoli na zapoznanie się z przejmowanym środowiskiem IT.

5. Co z aktualizacją “Dokumentacji Systemów IT”?

Jak każda czynność, tak i aktualizacja dokumentacji wymaga czasu i energii. W koszt obsługi serwisowej wliczamy utrzymywanie aktualnej “Dokumentacji środowiska IT”. Należy pamiętać, aby zmiany, które są wprowadzane w systemie IT, były na bieżąco wprowadzane do dokumentacji. Nie jutro, czy za tydzień, lecz tu i teraz. Z doświadczenia wiemy, że jak coś nie zostanie zrobione “teraz”, to z dużą dozą prawdopodobieństwa nie zostanie zrobione nigdy.

Przykład: Zmieniono podłączenia na kilku portach w szafie Rack, na patchpanelu. To taka zmiana powinna zostać zanotowana i po zakończeniu prac powinna nastąpić aktualizacja dokumentacji. Jeśli dokumentacja nie zostanie zaktualizowana o zmienione elementy, to bardzo szybko dojdzie do jej dezaktualizacji. Osoby odpowiedzialne za utrzymywanie “Dokumentacji Systemu IT” powinny zostać przeszkolone i mieć świadomość, po co jest dokumentacja i kiedy powinna być aktualizowana.

6. Podsumowanie

Mamy nadzieję, iż po przeczytaniu tego artykułu, wzrośnie świadomość i zrozumienie konieczności utrzymywania aktualnej “Dokumentacji Systemów IT”, zarówno wśród kadry zarządzającej, jak i osób odpowiedzialnych za systemy IT.