Kwalifikacja: INF.03 - Tworzenie i administrowanie stronami i aplikacjami internetowymi oraz bazami danych
Który z komponentów dokumentacji aplikacji powinien być zawarty w dokumentacji dla użytkownika?
Odpowiedzi
Informacja zwrotna
Opis obsługi funkcji systemu jest kluczowym elementem dokumentacji użytkownika, ponieważ ma na celu dostarczenie końcowemu użytkownikowi informacji o tym, jak efektywnie korzystać z aplikacji. W dokumentacji tej powinny znajdować się instrukcje krok po kroku, przykłady zastosowań oraz wyjaśnienia dotyczące funkcji i interfejsu użytkownika. Przykładowo, jeśli aplikacja jest systemem zarządzania projektami, dokumentacja użytkownika powinna zawierać szczegółowe opisy, jak tworzyć nowe projekty, przypisywać zadania, zarządzać kalendarzem oraz generować raporty. Zgodnie z wytycznymi standardów dokumentacji, takich jak ISO/IEC/IEEE 26511, dokumentacja użytkownika powinna być pisana w sposób zrozumiały i przystępny, aby umożliwić użytkownikom szybkie przyswojenie informacji i skuteczne wykorzystanie aplikacji. Kluczowym celem takiej dokumentacji jest zminimalizowanie potrzeby wsparcia technicznego oraz zwiększenie satysfakcji użytkowników z korzystania z systemu.
Opis kodu źródłowego nie jest odpowiedni do zawarcia w dokumentacji użytkownika, ponieważ skupia się na technicznych detalach implementacji, które są zrozumiałe głównie dla programistów i osób zajmujących się rozwojem oprogramowania. Tego typu dokumentacja jest istotna w kontekście rozwoju aplikacji, ale nie ma zastosowania w kontekście użytkownika końcowego, który nie jest zazwyczaj zainteresowany wewnętrzną strukturą kodu. Opis wykorzystanej technologii i bibliotek również nie jest adekwatny do dokumentacji użytkownika, ponieważ użytkownik nie musi znać szczegółów dotyczących technologii, na której oparta jest aplikacja. W większości przypadków, klienci są bardziej zainteresowani funkcjonalnościami i sposobem użytkowania aplikacji, a nie tym, jakie technologie zostały użyte w jej produkcji. Opis algorytmów zastosowanych w kodzie również nie jest właściwy, ponieważ użytkownicy końcowi rzadko potrzebują wiedzieć, jakie algorytmy stoją za działaniem aplikacji. Chociaż zrozumienie algorytmów może być przydatne dla inżynierów i programistów, dla przeciętnego użytkownika najważniejsze jest to, jak aplikacja działa w praktyce i jak ją wykorzystać do realizacji swoich potrzeb. Z tego względu, informacje te są istotne w kontekście dokumentacji technicznej, ale nie są użyteczne w dokumentacji użytkownika.