Czym jest dokumentacja użytkownika?
Dokumentacja użytkownika to część dokumentacji aplikacji przeznaczona dla osób korzystających z systemu, a nie dla programistów. Jej celem jest wyjaśnienie, jak obsługiwać aplikację i jak wykonać konkretne czynności.
W pytaniach egzaminacyjnych należy odróżniać ją od dokumentacji technicznej. Dokumentacja użytkownika opisuje funkcje systemu z perspektywy użytkownika, natomiast dokumentacja techniczna opisuje kod, algorytmy, technologie, strukturę bazy danych lub sposób wdrożenia.
Co powinna zawierać dokumentacja użytkownika?
Typowe elementy to:
- instrukcja obsługi funkcji systemu,
- opis sposobu logowania i wylogowania,
- opis ról użytkowników i dostępnych uprawnień,
- instrukcje wykonywania najważniejszych operacji,
- zrzuty ekranu lub przykładowe scenariusze użycia,
- opis komunikatów błędów i sposobów ich rozwiązania,
- wymagania dotyczące korzystania z aplikacji, np. obsługiwana przeglądarka.
Czego nie zawiera dokumentacja użytkownika?
Dokumentacja użytkownika zwykle nie zawiera:
- szczegółowego opisu kodu źródłowego,
- opisu zastosowanych bibliotek i frameworków,
- opisu algorytmów użytych w programie,
- informacji przeznaczonych wyłącznie dla administratora lub programisty.
Takie informacje należą do dokumentacji technicznej lub projektowej.
Przykład
Dla aplikacji sklepu internetowego dokumentacja użytkownika może zawierać instrukcję:
- Zaloguj się na konto klienta.
- Wyszukaj produkt.
- Dodaj produkt do koszyka.
- Przejdź do płatności.
- Potwierdź zamówienie.
To jest opis obsługi funkcji systemu, dlatego pasuje do dokumentacji użytkownika.