2024-05-10 10:36:11
  • Hello!
  • Whats ya doin?
  • ByeBye

[&]

3.145.15.1

Analiza plików Dokumentacji technicznej

workshop: #28-docs-tech.html

Dokumentacja techniczna

Przykłady, notatki, własna dokumentacja

Przygotowanie

  1. Pobierz dokumenty PDF

  2. Przygotuj plik/dokument do notatek

  3. Postępuj zgodnie z instrukcjami

1 Zadanie 1.1. Opis zadania

1. Przeanalizuj dostarczone pliki z Dokumentacji technicznej systemów informatycznych, w szczególności wskazane fragmenty/strony:

  1. ZDPAM (zse) – zapoznaj się, co powinna zawierać dokumentacja projektowa (na przykładzie aplikacji mobilnej),

  2. STWIOSI – przeanalizuj wskazane fragmenty dokumentacji (fragmenty w Tabela 1),

  3. AMODIT – przejrzyj całość dokumentacji.

Tabela 1. Fragmenty dokumentacji do analizy

Dokument Nr strony Zawartość
ZDPAM 1-10 (całość)

struktura dokumentu

AMODIT 1-11 (całość)

wymagania techniczne oraz konfiguracja

STWIOSI 10-12

terminologia

STWIOSI 13-15

akty prawne / normy

STWIOSI 16-25

akronimy

STWIOSI 64-69, 71

diagramy

STWIOSI 108-112

testy

STWIOSI 134-…

4.4.1 (i powiązane z punktem podpunkty)

STWIOSI 138-141

4.4.1.4

STWIOSI 148-150

źródła danych/informacji

STWIOSI 165

5.8.2 UI

2 Zadanie 1.2. Teoretyczne

2. Wynotuj następujące zagadnienia, które zostaną użyte do stworzenia przykładowej dokumentacji:

  1. podaj w skrócie informacje dotyczące zawartości dokumentacji technicznej

  2. określ rozmiar systemu/projektu oraz rodzaj dokumentacji, którego dotyczą wskazane trzy dokumenty

  3. w jakim celu umieszcza się słownik pojęć i definicji?

  4. co daje umieszczenie aktów prawnych i norm w dokumentacji?

  5. czym są akronimy i co one dają?

  6. do czego służą, co pokazują, czego dotyczą diagramy?

  7. o czym jest fragment dokumentacji związany z testami?

  8. co przedstawia punkt 4.4.1.4 w dostarczonej dokumentacji?

  9. co daje podpunkt źródeł danych i informacji?

  10. czy potrzebne są wizualizacje UI?

3 Zadanie 2. Praktyczne

3. Na podstawie dostarczonej przykładowej dokumentacji utwórz własną dokumentację techniczną dla wybranego projektu:

  1. System zgłoszeń Pracownik-Administracja (InBox)

  2. Aplikacja do aktualizacji informacji magazynowych (Hurtownia Produktów)

  3. Szablon witryny wraz z aktualizacją i konfiguracją witryny Szkolnej (ZSE-GW)

  4. Moduł do systemu edukacyjnego (moduł ustalany z prowadzącym)

  5. Moduł importu dokumentów Office (szczegóły u prowadzącego)

  6. Serwer pracowni komputerowej z usługami lokalnymi (mechanizm obrazowania i przywracania Systemu operacyjnego, zdalna baza danych MySQL, serwer plików Samba i FTP, serwer DNS, serwer kont użytkowników; szczegóły u prowadzącego)

  7. Aplikacja mobilna witryny/platformy internetowej (uczeń wybiera)

4 Dopasowanie przedmiotów do projektów

Temat

AI

AD

WI

CMS

ZAW

1.

v

x

v

x

v

2.

?

v

?

x

x

3.

v

x

v

v

x

4.

v

x

v

v

x

5.

v

x

v

v

x

6.

x

x

x

x

x

7.

x

x

x

x

x

Podsumowanie

  1. None or Empty