Dlaczego dokumentacja jest wazna?
Dokumentacja techniczna to czesto polowa oceny za prace dyplomowa lub kursowa. Nawet najlepszy kod bez dobrej dokumentacji nie otrzyma wysokiej oceny. Promotorzy zwracaja szczegolna uwage na jakosc opisu projektu.
Co powinna zawierac dokumentacja?
- Opis problemu — co rozwiazuje projekt?
- Analiza wymagan — wymagania funkcjonalne (user stories) i niefunkcjonalne (wydajnosc, bezpieczenstwo)
- Architektura systemu — diagram komponentow, wzorce projektowe
- Diagramy UML — use case, class diagram, sequence diagram, activity diagram
- Schemat bazy danych — diagram ER, opis tabel
- Opis implementacji — kluczowe algorytmy, struktura kodu
- API — endpointy, metody, parametry (jezeli dotyczy)
- Testowanie — scenariusze testowe, wyniki
- Instrukcja uruchomienia — krok po kroku
Narzedzia do dokumentacji
- Draw.io / Lucidchart — diagramy UML
- LaTeX / Word — tekst dokumentacji
- Swagger / OpenAPI — dokumentacja API
- Markdown — README w repozytorium
Najczestsze bledy
- Brak diagramow lub niskiej jakosci diagramy
- Kopiowanie kodu do dokumentacji bez wyjasnienia
- Brak instrukcji uruchomienia
- Zbyt ogolnikowy opis implementacji
Tworzymy kompletna dokumentacje techniczna do kazdego projektu. Zamow prace z pelna dokumentacja.