Standard dokumentacji analityczno-projektowej

BDG.V.2511.50.2015.AD
Ministerstwo Infrastruktury i Rozwoju
Załącznik AZ-1 do SOPZ
Standard Dokumentacji Systemu
Spis treści
1
Dokumentacja Systemu .................................................................................................................. 2
1.1
Dokumentacja analityczna ....................................................................................................... 2
1.2
Dokumentacja techniczna ....................................................................................................... 3
1.3
Dokumentacja użytkownika ..................................................................................................... 5
1
BDG.V.2511.50.2015.AD
Ministerstwo Infrastruktury i Rozwoju
1
Dokumentacja Systemu
Dokumentacja Systemu powinna zawierać następujące elementy:
1. Dokumentacja analityczna;
2. Dokumentacja techniczna;
3. Dokumentacja użytkownika.
1.1
Dokumentacja analityczna
W skład dokumentacji analitycznej wchodzą:
1. Przypadki użycia
Przypadek użycia jest opisem tego, w jaki sposób zewnętrzni względem systemu aktorzy
korzystają z systemu i osiągają określoną korzyść biznesową.
W opisie przypadku użycia wymienia się uczestniczących aktorów, cel, warunki wstępne
i końcowe oraz scenariusz biegu wydarzeń z ewentualnym uzupełnieniem przez scenariusze
alternatywne. Scenariusz główny opisuje, operacja po operacji, jak aktor używa systemu
realizując cel przypadku użycia i jakie procesy zachodzą wewnątrz systemu, aby zrealizować
cel aktora.
Przypadki użycia mogą być ze sobą powiązane za pomocą różnego rodzaju relacji.
Najbardziej typowe są relacje:
 include, które oznaczają, że dany przypadek użycia korzysta zawsze w swoim
scenariuszu głównym z innego przypadku użycia,
 extend, które oznaczają, że dany przypadek użycia jest rozszerzeniem innego
przypadku użycia.
Jeśli, na przykład przy modyfikacji jakiegoś obiektu użytkownik musi go najpierw wyszukać,
oznacza to relację include między przypadkami użycia „Modyfikacja obiektu” i „Wyszukiwanie
obiektu”.
Jeśli przy podglądzie danych użytkownik może, ale nie musi, wydrukować dane, oznacza to
relację extend między przypadkami np. „Podgląd danych klienta” i „Wydruk oświadczenia”.
Niekiedy wprowadza się wyjątkowo także inne relacje, np. poprzedza, jeśli chcemy
zaznaczyć, że jakiś przypadek użycia musi być zawsze wykonany przed innym, itp.
Scenariusz działań wewnątrz przypadku użycia może być przedstawiony w postaci słownego
opisu lub diagramu sekwencji. Opis słowny lub diagram sekwencji pokazuje, z jakimi
2
BDG.V.2511.50.2015.AD
Ministerstwo Infrastruktury i Rozwoju
komponentami współdziała aktor (jak uruchamia żądaną akcję i jak dostaje wyniki) oraz jak
żądane przez użytkownika efekty są realizowane wewnątrz systemu.
Słownie opisano wszystkie przypadki użycia. Opisy przedstawiają sposób korzystania
z aplikacji przez użytkownika.
2. Model komponentów i infrastruktury
Przedstawia fizyczne elementy wchodzące w skład systemu i połączenia między nimi. W jego
skład wchodzą:

schemat i opis struktury i organizacji połączeń sieciowych;

schemat i opis połączeń sprzętu komputerowego i urządzeń dodatkowych;

schemat i opis organizacji informacji przetwarzanych w systemie, obejmujący zarówno
strukturę oprogramowania współpracującego z systemem (np. oprogramowanie
sieciowe, systemy operacyjne, bazy danych);

opis parametrów sprzętu, urządzeń i komponentów oprogramowania;

schemat i opis integracji systemu z innymi systemami.
3. Model danych biznesowych
Model danych biznesowych zawiera:
1.2

zakres danych przechowywanych przez system;

konceptualny model danych;

model klas;

fizyczny model danych;

szacowany roczny przyrost rekordów głównych relacji systemu.
Dokumentacja techniczna
W skład dokumentacji technicznej wchodzą:
1. Dokumentacja utrzymaniowa
Produkt powinien zawierać udokumentowany i aktualny stan wiedzy w zakresie następujących
merytorycznych kwestii:

procesów obsługi incydentów i rozwiązywania problemów;

zarządzania zmianą;

procedury aktualizacji systemu;
3
BDG.V.2511.50.2015.AD
Ministerstwo Infrastruktury i Rozwoju

procedury obsługi rejestru serwisowego;

procedury raportowania wykonanych usług.
2. Dokumentacja eksploatacyjna
Dokument opisuje czynności wymagane i zalecane przy eksploatacji Systemu w MIiR.
Dokumentacja eksploatacyjna zawiera:

procedury okresowych kopii bezpieczeństwa i ich przechowywania;

procedury zarządzania grupami użytkowników i hasłami;

procedury audytu działania administratorów (np. kontrola logów);

procedury audytu zmian w systemie (np. kontrola logów);

procedury modyfikacji oprogramowania i sprzętu;

procedury odtwarzania danych i Systemu po awarii;

procedury określania lokalizacji krytycznych ról i definicja ról;

procedura kontroli zdarzeń dotyczących bezpieczeństwa;

dokumentację po instalacji usługi klastrowej i infrastruktury sieciowej;

dokumentację techniczną sondy IPS-IDS;

procedury eksploatacyjne systemu Spectator.
3. Dokumentacja administratora
Dokument zawiera opis funkcjonalności przewidzianych do administrowania Systemem.
Produkt będzie składał się z następujących elementów:

dokumentacji Użytkownika w zakresie funkcjonalności obsługiwanych z poziomu
panelu administracyjnego Systemu

dokumentacji Użytkownika w zakresie funkcjonalności obsługiwanych przez aplikację
do zarządzania uprawnieniami użytkownikami Systemu.

innych punktów wynikających z wyboru metodyki realizacji projektu.
4. Report builder
Dokument zawiera opis narzędzi do przygotowywania szablonów raportów i raportów.
Produkt będzie składał się z następujących elementów:

dokumentacji
Użytkownika
w
zakresie
Beneficjenta;
4
funkcjonalności
obsługiwanych
przez
BDG.V.2511.50.2015.AD
Ministerstwo Infrastruktury i Rozwoju

dokumentacji Użytkownika w zakresie funkcjonalności obsługiwanych przez Instytucje
Zarządzającą;
1.3

dokumentacji Administratora;

innych punktów wynikających z wyboru metodyki realizacji projektu.
Dokumentacja użytkownika
Dokumentacja użytkownika składa się z 3 dokumentów:
1. Dokumentacji użytkownika - całość
Produkt będzie składał się z następujących elementów:

dokumentacji
Użytkownika
w
zakresie
funkcjonalności
obsługiwanych
przez
Beneficjenta;

dokumentacji Użytkownika w zakresie funkcjonalności obsługiwanych przez Instytucje
Zarządzającą;

innych punktów wynikających z wyboru metodyki realizacji projektu.
2. Dokumentacji użytkownika - Beneficjent
Produkt będzie składał się z następujących elementów:

dokumentacji
Użytkownika
w
zakresie
funkcjonalności
obsługiwanych
przez
Beneficjenta;

innych punktów wynikających z wyboru metodyki realizacji projektu.
3. Dokumentacji użytkownika – Instytucja Zarządzająca
Produkt będzie składał się z następujących elementów:

dokumentacji Użytkownika w zakresie funkcjonalności obsługiwanych przez Instytucje
Zarządzającą;

innych punktów wynikających z wyboru metodyki realizacji projektu.
5