Słownik pojęć IT Utrzymanie i DevOps
Dokumentacja techniczna
Opis, jak działa system, jak go uruchomić i gdzie są dostępy - bez niego projekt zależy od pamięci jednej osoby.
Inne określenia: dokumentacja projektu, dokumentacja systemu, technical documentation
Co powinna zawierać dokumentacja techniczna strony lub systemu?
Dokumentacja techniczna to zbiór informacji pozwalających innemu zespołowi zrozumieć, uruchomić i rozwijać system: opis architektury, lista usług i dostępów, sposób wdrażania zmian, konfiguracja serwera i integracji. Jej wartość wychodzi na jaw w momencie zmiany wykonawcy albo awarii, gdy osoba, która wszystko wiedziała, jest nieosiągalna.
Minimum, które powinno istnieć
- Lista usług i kont: domena, hosting, poczta, repozytorium kodu, narzędzia analityczne - z informacją, na kogo są zarejestrowane.
- Opis, jak zbudowany jest system i jakich zewnętrznych usług używa.
- Instrukcja uruchomienia projektu i wdrażania zmian.
- Opis integracji z innymi systemami i sposobu ich konfiguracji.
- Informacja, gdzie są kopie zapasowe i jak z nich odtworzyć serwis.
Czego dokumentacja nie powinna zawierać
Haseł zapisanych otwartym tekstem. Dokumentacja wskazuje, gdzie są dostępy i kto nimi zarządza, a same dane logowania przechowuje się w menedżerze haseł z kontrolą uprawnień.
Pytanie warte zadania wykonawcy
Co dostanę, jeśli za rok zechcę przekazać projekt komuś innemu. Brak konkretnej odpowiedzi oznacza, że przejęcie zacznie się od odtwarzania wiedzy z kodu i serwera, co zawsze trwa dłużej i kosztuje więcej niż napisanie dokumentacji na bieżąco.
Częste pytania o Dokumentacja techniczna
Czy prosta strona firmowa potrzebuje dokumentacji?
Wystarczy wersja minimalna: lista dostępów, informacja o hostingu i domenie oraz miejsce przechowywania kopii zapasowych. Jedna strona tekstu potrafi zaoszczędzić wiele dni przy zmianie wykonawcy.
Kto powinien aktualizować dokumentację?
Wykonawca przy każdej istotnej zmianie w systemie. Warto zapisać to w umowie, bo dokumentacja przygotowana raz na starcie po roku opisuje już inny system.
Porozmawiajmy o Twoim biznesie.
Przedstaw nam swoje potrzeby - zaproponujemy rozwiązanie i konkretną wycenę. Bez zobowiązań.