Kwalifikacje w Zawodzie - Testy zawodowe online | Egzaminy Zawodowe

KWALIFIKACJA INF3 - CZERWIEC 2018



PYTANIE NR 40.
Który z elementów dokumentacji aplikacji powinien znaleźć się w dokumentacji użytkownika?
A.
B.
C.
D.
Wyjaśnienie poprawnej odpowiedzi:
Dokumentacja użytkownika jest przeznaczona dla osób korzystających z aplikacji, więc opisuje jak używać funkcji i jak wykonać typowe zadania. Dlatego poprawny jest "Opis obsługi funkcji systemu." Informacje o kodzie, bibliotekach czy algorytmach są potrzebne głównie programistom i należą do dokumentacji technicznej.

Pełne wyjaśnienie:

Dokumentacja aplikacji zwykle dzieli się na dwie główne grupy: dokumentację użytkownika oraz dokumentację techniczną/deweloperską. Kluczowa jest tu grupa docelowa:

  • Użytkownik końcowy chce wiedzieć, co system umożliwia i jak wykonać konkretne czynności.
  • Programista lub administrator potrzebuje informacji, jak system jest zbudowany i jak go rozwijać/utrzymywać.

Dlatego odpowiedź "Opis obsługi funkcji systemu" jest właściwa: w dokumentacji użytkownika umieszcza się instrukcje krok po kroku, opis ekranów i elementów interfejsu, scenariusze użycia (np. logowanie, dodanie danych, wyszukiwanie, generowanie raportu), a także proste wskazówki rozwiązywania typowych problemów.

Pozostałe odpowiedzi dotyczą perspektywy implementacyjnej, typowej dla dokumentacji technicznej:

  • "Opis kodu źródłowego" jest przydatny w utrzymaniu i rozwoju oprogramowania, ale dla użytkownika końcowego jest niezrozumiały i nie pomaga w wykonaniu zadań.
  • "Opis wykorzystanej technologii i bibliotek" (np. frameworki, biblioteki) ma znaczenie przy wdrożeniu, rozbudowie i kompatybilności, lecz nie jest potrzebny do codziennej obsługi funkcji.
  • "Opis algorytmów zastosowanych w kodzie" wyjaśnia, jak system realizuje obliczenia lub przetwarzanie danych; użytkownikowi wystarcza informacja, co system robi i jak z tego skorzystać.

Na egzaminie warto zapamiętać prostą zasadę: użytkownikowi opisujemy zadania i interfejs, a deweloperowi opisujemy kod, architekturę i technologie. Takie rozdzielenie poprawia czytelność dokumentacji i obniża liczbę błędów wynikających z nadmiaru zbędnych szczegółów.

Dodatkowe pytania

Dodatkowe pytania (FAQ):
Co to jest dokumentacja użytkownika aplikacji?
Dokumentacja użytkownika to instrukcja przeznaczona dla osób korzystających z aplikacji. Opisuje, jak wykonać zadania (np. logowanie, wprowadzanie danych, generowanie raportu), jak działa interfejs oraz jak rozwiązać typowe problemy, bez wchodzenia w szczegóły kodu.
Jaka jest różnica między dokumentacją użytkownika a techniczną?
Dokumentacja użytkownika odpowiada na pytanie: jak korzystać z funkcji. Dokumentacja techniczna odpowiada: jak system jest zbudowany (kod, biblioteki, architektura, algorytmy, API). Różnica wynika z innego odbiorcy: użytkownik vs programista/administrator.
Dlaczego opis kodu źródłowego nie trafia do dokumentacji użytkownika?
Użytkownik końcowy zwykle nie programuje i nie potrzebuje znać implementacji. Opis kodu jest dla utrzymania i rozwoju systemu, a w instrukcji użytkownika byłby niezrozumiały i utrudniałby znalezienie informacji o obsłudze funkcji.
Jakie elementy najczęściej zawiera dokumentacja użytkownika?
Najczęściej są to: instrukcje krok po kroku, opis ekranów i przycisków, scenariusze użycia (typowe zadania), lista funkcji z perspektywy użytkownika, sekcja FAQ oraz proste porady "Rozwiązywanie problemów" (np. błędne hasło, brak dostępu).
Czy dokumentacja użytkownika powinna zawierać opis technologii i bibliotek?
Zwykle nie. Informacje o technologiach (frameworki, biblioteki) są potrzebne zespołowi technicznemu do rozwoju i utrzymania. Użytkownikowi wystarcza opis funkcji i sposobu pracy w aplikacji. Wyjątki zdarzają się rzadko, np. przy wymaganiach środowiskowych.
Kiedy przydaje się dokumentacja techniczna w projekcie webowym?
Jest potrzebna podczas wdrożenia, utrzymania i rozbudowy aplikacji: gdy trzeba zrozumieć architekturę, zależności bibliotek, strukturę bazy danych lub API. Ułatwia onboarding nowych programistów i ogranicza ryzyko błędów przy zmianach w systemie.
Jak odróżnić opis funkcji od opisu algorytmu w dokumentacji?
Opis funkcji mówi co użytkownik może zrobić i jakie są kroki w interfejsie. Opis algorytmu tłumaczy jak system to realizuje wewnętrznie (logika przetwarzania, reguły obliczeń). Jeśli treść wymaga wiedzy programistycznej, to zwykle nie jest dla użytkownika.
Jakie błędy uczniowie popełniają w pytaniach o dokumentację aplikacji?
Najczęstsze błędy to mylenie odbiorców dokumentacji oraz wybieranie odpowiedzi technicznych, bo brzmią "bardziej profesjonalnie". Inny błąd to założenie, że "dokumentacja aplikacji" zawsze oznacza dokumentację deweloperską, a nie instrukcję dla użytkownika.
Jak napisać krótki fragment dokumentacji użytkownika do logowania?
Skup się na krokach: 1) wejdź na stronę logowania, 2) wpisz e-mail i hasło, 3) kliknij "Zaloguj", 4) w razie błędu sprawdź poprawność danych lub użyj "Nie pamiętam hasła". Unikaj opisu kodu i bibliotek.
Jak przygotować się do zadań egzaminacyjnych z INF.3 o dokumentacji?
Utrwal podział: użytkownik (instrukcja, interfejs, zadania, FAQ) vs techniczna (kod, biblioteki, architektura, API). Ćwicz dopasowywanie przykładów treści do właściwego rodzaju dokumentacji i zwracaj uwagę na słowa "obsługa", "instrukcja", "kod", "algorytm".
info

To pytanie poprawnie rozwiązuje 65% zdających egzamin. średnie

W praktyce zawodowej kluczowe jest to, że dokumentacja użytkownika jest przeznaczona dla osób korzystających z aplikacji, więc opisuje jak używać funkcji i jak wykonać typowe zadania.

Źródła:

  • ISO/IEC/IEEE 26512:2018, Systems and software engineering — Requirements for acquirers and suppliers of information for users
  • IEEE Std 1063, Standard for Software User Documentation

Materiały:

  • ISO/IEC/IEEE 26512:2018 (wymagania dla dokumentacji użytkownika i informacji dla użytkownika)
  • IEEE 1063 (standard dokumentacji użytkownika oprogramowania)
  • Materiały dydaktyczne do INF.3 dotyczące dokumentacji projektowej i powdrożeniowej

Aktualizacja pytania: 31.03.2026

Aktualizacja pytania: 31.03.2026
📡 Brak połączenia internetowego