Quality Power
Dokumentacja projektu dla klienta — co oddać poza samym efektem
Dokumentacja nie musi mieć czterdziestu stron. Pięć stron, które pozwalają klientowi działać samodzielnie i oszczędzają Twój czas.
Dokumentacja przy projekcie dla małej firmy nie służy do tego, żeby coś udokumentować. Służy do tego, żeby klient nie musiał dzwonić w sprawie rzeczy, które zrobi sam w dwie minuty. Dlatego czterdzieści stron opisu technicznego jest bezużyteczne, a pięć kartek z czterema odpowiedziami — nie.
Dodatkowo, od strony wykonawcy: dokumentacja jest tym, co odróżnia zlecenie zamknięte od zlecenia, które wraca z pytaniami przez pół roku.
Co powinno być w dokumentacji
| Element | Treść | Dla kogo |
|---|---|---|
| Jak zmienić to, co klient zmienia najczęściej | Cena, treść, zdjęcie, realizacja, godziny — krok po kroku | Klient, codziennie |
| Gdzie co jest wykupione | Domena, hosting, licencje, u kogo i do kiedy | Klient, raz w roku |
| Jak wygląda kopia zapasowa | Gdzie jest, jak często powstaje, jak odtworzyć | Klient i następny wykonawca |
| Co jest z czym połączone | Formularz, analityka, płatności, integracje | Następny wykonawca |
| Czego nie ruszać i dlaczego | Lista rzeczy, które psują całość | Klient, zapobiegawczo |
| Z kim się kontaktować i w jakiej sprawie | Ty, hosting, dostawca płatności | Klient przy problemie |
Pierwszy wiersz jest tym, który oszczędza najwięcej czasu obu stronom, a ostatni tym, który najczęściej ratuje sytuację przy awarii. Reszta jest ważna rzadziej, ale wtedy bardzo.
Format, który jest czytany
- Krótkie instrukcje ze zrzutami ekranu, nie opis słowny. Trzy zrzuty ze strzałkami zastępują stronę tekstu.
- Jedna czynność na jedną instrukcję. „Jak zmienić cenę” osobno od „jak dodać realizację”.
- Nagranie ekranu przy czynnościach wieloetapowych. Dwie minuty nagrania zastępuje pięć stron opisu — i jest szybsze w przygotowaniu.
- Jedno miejsce, do którego klient ma trwały dostęp. Dokumentacja wysłana mailem ginie w skrzynce po trzech miesiącach.
- Data aktualizacji na pierwszej stronie. Przy dokumentacji ze zrzutami ekranu to informacja, czy nadal odpowiada rzeczywistości.
Czego nie wkładać
- Haseł. Dostępy przekazuje się osobno, przez menedżer haseł, nie w dokumencie — co opisuję w tekście o zarządzaniu hasłami w firmie.
- Opisu technicznego, którego klient nie zrozumie. Jeśli ma znaczenie dla następnego wykonawcy, powinien być w osobnej, oznaczonej części.
- Zrzutów z danymi innych klientów. Przy dokumentacji z panelu to częsty przypadek i realny problem.
- Rzeczy, które zmienią się w trzy miesiące, bez zaznaczenia, że mogą się zmienić.
Dlaczego to się opłaca wykonawcy
Dokumentacja wygląda na pracę dla klienta, a najwięcej oszczędza wykonawcy. Trzy konkretne efekty:
- Mniej pytań po oddaniu — i to tych najbardziej irytujących, bo dotyczących rzeczy prostych.
- Łatwiejsze zamknięcie etapu. Przekazanie dokumentacji jest naturalnym punktem końcowym, co pomaga przy protokole odbioru.
- Lepsza pozycja przy rozmowie o opiece. Klient, który widzi, co może zrobić sam, i co wymaga wsparcia, podejmuje świadomą decyzję — zamiast płacić za abonament, którego nie rozumie.
Jest też odwrotny wniosek i warto go powiedzieć wprost: wykonawca, który nie zostawia dokumentacji, buduje zależność. Działa to krótkoterminowo i kończy się tym, że przy pierwszej zmianie wykonawcy klient zostaje bez niczego — co opisuję w rankingu rzeczy do sprawdzenia w umowie na opiekę.
Wersja minimalna, na jedną godzinę
| Co | Forma |
|---|---|
| Trzy najczęstsze czynności klienta | Trzy krótkie instrukcje ze zrzutami |
| Lista usług i terminów wygaśnięć | Pięć wierszy w arkuszu |
| Gdzie jest kopia zapasowa | Dwa zdania |
| Kontakty przy problemach | Trzy pozycje z numerami |
| Czego nie ruszać | Lista pięciu punktów |
Strona oddana razem z instrukcją, nie bez niej
Przy przekazaniu strony klient dostaje dostępy na własne konta, kopię zapasową i krótkie instrukcje do rzeczy, które zmienia najczęściej. Celowo buduję tak, żeby cena, treść i realizacje dały się zmienić bez dzwonienia do mnie.
Najczęstsze pytania
Jak długa powinna być dokumentacja projektu?
Pięć kartek wystarcza w większości projektów dla małych firm. Liczy się nie objętość, a to, czy odpowiada na czynności, które klient wykonuje najczęściej.
Co jest najważniejsze w dokumentacji?
Krótkie instrukcje do rzeczy, które klient zmienia sam — ceny, treści, zdjęcia — oraz lista kontaktów przy problemach. Reszta jest potrzebna rzadziej, ale wtedy bardzo.
Czy wkładać do dokumentacji hasła?
Nie. Dostępy przekazuje się osobno, przez menedżer haseł albo odnośnik wygasający po użyciu. Dokument z hasłami krąży potem w skrzynkach bez kontroli.
Czy dokumentacja nie zmniejszy zapotrzebowania na moją pracę?
Zmniejszy liczbę pytań o rzeczy proste, a nie zapotrzebowanie na realne zlecenia. Klient, który wie, co może zrobić sam, chętniej zleca to, czego sam nie zrobi.
