Dodatek bez dokumentacji jest zależnością od jednej osoby. Gdy przestaje działać, a autor jest nieosiągalny, jedyną drogą bywa napisanie go od nowa.
Co powinno zostać przekazane
- kod źródłowy wraz z prawem do dalszych zmian,
- opis działania: co robi, kiedy się uruchamia, na czym operuje,
- instrukcja instalacji i konfiguracji,
- lista wymagań: wersje, licencje, uprawnienia,
- opis miejsc, które trzeba sprawdzić po aktualizacji systemu,
- dane kontaktowe do wsparcia i jego zakres.
Ta lista nie jest formalnością. Każda pozycja odpowiada na pytanie, które pojawi się przy pierwszym problemie — i wtedy albo odpowiedź jest zapisana, albo trzeba szukać autora.
Kod źródłowy w umowie
Kwestia do ustalenia przed rozpoczęciem prac, nie po. Rozwiązanie, którego firma nie może samodzielnie zmienić ani zlecić komu innemu, jest uzależnieniem bez wyjścia.
Osobno ustala się prawo do dalszych zmian: czy firma może zlecić poprawkę komu innemu, czy potrzebuje zgody autora. To zapis w umowie, nie kwestia dobrej woli, i najłatwiej uzgodnić go przed rozpoczęciem prac.
Opis dla użytkownika
Krótki, z ekranami: co kliknąć, żeby uzyskać efekt. Dokumentacja techniczna nie zastępuje instrukcji obsługi — czytają je różne osoby w różnych sytuacjach.
Wystarczy kilka stron: do czego dodatek służy, kto go używa, co kliknąć i co zrobić, gdy pojawi się komunikat o błędzie. Ta ostatnia część jest najczęściej pomijana, a odpowiada za większość telefonów po pomoc.
Miejsca wrażliwe
Autor wie, które fragmenty zależą od wersji systemu i co sprawdzić po aktualizacji. Ta wiedza przekazana wprost oszczędza godzin diagnozy przy pierwszym problemie.
Chodzi o konkrety: które funkcje systemu dodatek wykorzystuje, jakie pola czyta, na czym opiera warunki. Przy aktualizacji systemu ta lista zamienia się w listę rzeczy do sprawdzenia — bez niej sprawdza się wszystko albo nic.
Co dodatek dopisał do bazy
Jeśli rozszerzenie tworzy własne pola i słowniki albo tabele pomocnicze, ich wykaz musi trafić do dokumentacji wraz z opisem znaczenia. To najczęściej gubiona informacja, a bez niej dane po latach są nieczytelne: zostaje kolumna z wartościami, o których nikt nie wie, co oznaczają.
Dane dostępowe
Konta techniczne utworzone na potrzeby dodatku muszą trafić do ewidencji firmy. Konto założone przez wykonawcę i znane tylko jemu jest luką, która zostaje po zakończeniu współpracy.
To samo dotyczy kluczy do usług zewnętrznych, z których dodatek korzysta. Powinny być zapisane po stronie firmy i dać się wymienić bez udziału autora — inaczej zakończenie współpracy oznacza przestój.
Kiedy to przekazać
Dokumentacja powstaje w trakcie prac, a nie po nich. Przekazana razem z uruchomieniem jest częścią odbioru; spisywana po miesiącach bywa niekompletna, bo autor sam już nie pamięta szczegółów. Warto ująć ją w zakresie prac przy wdrożeniu dodatku, żeby nie stała się osobnym zamówieniem.
