Dokumentacja techniczna

Dokumentacja techniczna
Polecane artykuły


Dokumentacja techniczna to dokument opisujący techniczne działanie i parametry techniczne, które stanowią podstawę do wdrożenia produktu końcowego (wyrobu, budowli, instalacji itp.). Zawiera wszystkie potrzebne dane umożliwiające wykonanie danego wyrobu. Mając do dyspozycji dokumentację techniczną można nie tylko podać przybliżony czas realizacji poszczególnych części składowych planowanego projektu ale także przedstawić wycenę kosztu całości realizacji (kosztorys), dzięki czemu można uniknąć dalszych nietrafionych inwestycji, w razie gdyby klient po uprzedniej analizie uznał, iż nie stać go na wdrożenie danego systemu, produkcję wyrobu, montaż instalacji itp. "W przypadku sklepów internetowych tworzenie tego dokumentu powinna poprzedzać specyfikacja funkcjonalna, która warunkuje dobór technologii wykonania"[1].

"Dokumentacja techniczna jest bardzo istotnym elementem projektu informatycznego. Bez niej wiele poważnych przedsięwzięć zakończyło się porażką. Bardzo skomplikowane i rozbudowane (a przez to kosztowne) projekty zazwyczaj posiadają cały pakiet dokumentacji. Nazywane pogardliwie stertami niepotrzebnych papierów sprawiają, że ostatecznie wszystko (przy zachowaniu należytej staranności) działa poprawnie.[2]"

Zawartość dokumentacji technicznej

Dokumentacja techniczna powinna[3]:

  • "zawierać opis rozwiązania konstrukcyjnego,
  • charakterystykę materiałową,
  • informację dotyczącą projektowanych właściwości użytkowych wyrobu,
  • określać warunki zastosowania wyrobu,

w miarę potrzeby

  • zawierać instrukcję obsługi,
  • instrukcję eksploatacji."

A. Górecki podaje natomiast, że w niektórych przypadkach zawartość dokumentacji może zostać ograniczona tylko do niektórych dokumentów jak np. "receptura, opis przebiegu procesu technologicznego, warunki techniczne produkcji, skład wsadu[4]."

Inne dokumentacje powiązane z dokumentacją techniczną

Dokumentacja wdrożeniowa

Dokumentację tą sporządza się osobom, które odpowiadają za wdrożenie produktu końcowego. Porównując ją do dokumentacji technicznej można zauważyć, że zawiera ona mniej informacji dotyczących "wewnętrznych zależności i komponentów ale zawiera wszystkie szczegóły wymagań, które musi spełnić środowisko pracy produktu- liczba serwerów baz danych, aplikacji, maksymalne (zalecane) wartości parametrów konfiguracyjnych itp." W przypadku kiedy wdrożenie jest dokonywane przez osoby, które nie należą do zespołu projektowego (niezależnie czy jest to zespół wdrożeniowy naszej firmy czy nie) sporządzenie tej dokumentacji jest obligatoryjne[5].

Dokumentacja użytkownika

Przygotowywana dla użytkowników końcowych. Dokument ten jest często niezastąpiony jeżeli rozwiązanie jest "mało intuicyjne", czy też jeżeli schemat przebiegu pracy jest skomplikowany np. "przejdź tu, kliknij tu, pójdź tam zaznacz tamto, aby zatwierdzić, przejdź w kolejne miejsce- choć wydaje się to absurdalne, takie systemy istnieją"[6].

Dokumentacja projektu

Dokumentacja techniczna projektu powstaje w oparciu o dokumentację funkcjonalną ("w której przypadku użycia, procesy biznesowe, przepływ pracy podano w formie tekstu, obrazów oraz diagramów UML"). Jeżeli opis funkcjonalności jest napisany odpowiednio możliwe jest powstanie takiego wyrobu, który będzie odpowiadał wszystkim założeniom projektu. "Istnieje wiele technik zbierania wymagań funkcjonalnych (np. use cases- przypadki użycia, user stories- historie użytkowników. Obie metody opisu wymagań zostały opisane w odpowiedzi na pytanie: "Jak skutecznie zebrać wymagania?")." Projekt przedstawiony w formie dokumentacji ułatwia jego szybkie wdrożenie. "Jeżeli projekt składa się z kilku mniejszych modułów (np. aplikacji głównej i aplikacji pośredniczącej w komunikacji), to takie informacje również powinny zostać zawarte w dokumentacji[7]".

Bibliografia

Przypisy

  1. P. Karwatka i in., 2013, s. 94
  2. P. Karwatka i in., 2013, s. 94
  3. D. Wróblewski, 2016, s. 163
  4. A. Górecki, 2006, s. 10
  5. P. Karwatka i in., 2013, s. 95
  6. P. Karwatka i in., 2013, s. 96
  7. P. Karwatka i in., 2013, s. 96

Autor: Aleksandra Brózda