1. Podstawy dokumentacji projektowej
Dokumentacja jest tak samo istotna jak kod: ułatwia współpracę w zespole, wprowadzanie zmian (konserwację) oraz pomaga klientowi zrozumieć produkt i poprawnie z niego korzystać. [web:31][web:36]
2. Dokumentacja użytkowa (instrukcja dla klienta)
Dokumentacja użytkowa jest przeznaczona dla użytkownika końcowego lub klienta biznesowego, dlatego powinna być napisana prostym, nietechnicznym językiem i skupiać się na funkcjach aplikacji oraz typowych scenariuszach użycia. [web:37]
Kluczowe elementy dokumentacji użytkowej
- Wprowadzenie i cel: krótki opis, do czego służy aplikacja oraz jakie problemy rozwiązuje.
- Wymagania systemowe: potrzebny sprzęt i oprogramowanie (np. system operacyjny, przeglądarka, rozdzielczość ekranu).
- Instrukcja użytkowania: przewodniki krok po kroku po najważniejszych funkcjach, z czytelnym nazewnictwem przycisków i pól formularzy. [web:37]
- Rozwiązywanie problemów (FAQ): wskazówki, co zrobić przy typowych błędach (np. brak możliwości logowania, reset hasła).
Przykład sekcji: Instrukcja użytkowania (logowanie)
- Otwórz aplikację pod adresem: https://aplikacja.pl.
- W polu Login wpisz swój adres e‑mail.
- W polu Hasło wpisz hasło otrzymane w wiadomości powitalnej.
- Kliknij przycisk Zaloguj i poczekaj na przekierowanie do panelu głównego.
3. Dokumentacja techniczna (dla programisty)
Dokumentacja techniczna jest przeznaczona dla programistów i administratorów, którzy rozwijają, utrzymują i diagnozują system, dlatego powinna opisywać wewnętrzną strukturę i zastosowane technologie. [web:36][web:38]
Kluczowe elementy dokumentacji technicznej
- Architektura systemu: opis warstw (np. frontend, backend, baza danych) oraz sposób komunikacji między nimi; często przedstawiany na prostym diagramie blokowym. [web:36]
- Diagram bazy danych (ERD): wizualny schemat tabel, kluczy głównych i obcych oraz relacji (1:1, 1:N, N:M).
- Technologie i wymagania: lista języków, frameworków, bibliotek i zewnętrznych usług (np. HTML5, CSS3, JavaScript, MySQL, REST API).
- Instrukcja wdrożenia: opis uruchomienia projektu w środowisku deweloperskim i produkcyjnym (instalacja zależności, konfiguracja bazy, zmienne środowiskowe).
Przykład sekcji: Struktura bazy danych
W systemie zastosowano bazę danych MySQL. Główne tabele i relacje:
- Użytkownicy (id_użytkownika PK, nazwisko, email)
- Zamówienia (id_zamówienia PK, id_użytkownika FK, data_zamówienia, status)
- Relacja: jeden użytkownik może mieć wiele zamówień (1:N).
Przykład sekcji: Struktura plików i katalogów
/projekt-INF03/
├── index.html
├── css/
│ └── style.css
├── js/
│ └── script.js
├── dokumentacja/
│ └── dokumentacja_techniczna.pdf
└── README.md
4. Podsumowanie i wymogi INF.03
Na egzaminie INF.03 należy wykazać się umiejętnością przygotowania zarówno dokumentacji użytkowej, jak i technicznej do tworzonej aplikacji lub witryny. [web:31][web:35]