Raport dla przypadków użycia

Z modelem przypadków użycia tworzonym przez analityków w programie Enterprise Architect powinno się zapoznać wielu interesariuszy projektu. Spośród nich można wymienić projektantów, programistów, ale przede wszystkim przedstawicieli klienta, takich jak kluczowi użytkownicy, eksperci dziedzinowi i inni. W związku z tym, jeśli decydujemy się na opisywanie scenariuszy przypadków użycia w formie Structured Scenario w EA - powinniśmy również zadbać o ich stronę dokumentacyjną.
Profesjonalnie przygotowany raport poprawia czytelność i odbiór wyników pracy fazy analizy.



Metody generowania raportów RTF stanowią treść artykułu Generowanie raportów RTF w EA. Podstawowe kwestie związane z edycją szablonów można znaleźć w artykule Edycja szablonów RTF.

Tutaj chciałbym zaprezentować przykładowy szablon raportu dla przypadków użycia.

Szablon ten zawiera nagłówki numerowane dla nazw pakietów oraz nazw przypadków użycia. Nazwę pakietu należy traktować jako nazwę obszaru funkcjonalnego grupującą zestaw przypadków użycia. Dla każdego pakietu prezentowany jest diagram przypadków użycia wraz z numerem rysunku oraz nazwą diagramu.
Jeśli pakiet nie zawiera żadnego diagramu, wówczas ta sekcja zostanie pominięta w raporcie. Jeśli diagramów będzie więcej niż jeden, wówczas zostaną one wszystkie uwzględnione w raporcie, chyba że we właściwościach diagramu zostanie zaznaczona opcja Exclude image from RTF Documents.
Jeśli dany pakiet zawiera podpakiety, wówczas ich zawartość zostanie również uwzględniona dzięki umieszczeniu sekcji child packages> <child packages.

W ramach opisu przypadku użycia wykorzystano:

• jego nazwę (jako nagłówek), 
• opis przypadku użycia (pole Notes),
• listę skojarzonych wymagań poprzez relację Realization - w sekcji External requirements,
• listę warunków początkowych - w sekcji  constraint-pre (aby wymienić warunki początkowe w tym miejscu należy w edytorze szablonów, na liście Sections zmienić kolejność sekcji przesuwając ją powyżej sekcji Scenario),
• listę scenariuszy w rozbudowanej formie,
• diagram dla przypadku użycia, o ile istnieje,
• listę warunków końcowych - w sekcji constraint-post.

Sekcja scenariusza obejmuje:

• typ scenariusza - ElemScenario.Type,
• nazwę scenariusza - ElemScenario.Scenario,
• opis scenariusza - ElemScenario.Notes,
• numer kroku - Scenario_Structured.Step,
• treść kroku - Scenario_Structured.Action,
• przejście do innych scenariuszy: numer kroku (Exception.Step) oraz nazwę scenariusza (Exception.Name).

Poniżej zaprezentowano przykładowy przypadek użycia zaraportowany przy użyciu tego szablonu.

Zaprezentowany szablon raportu przypadków użycia stanowi jedynie jeden z możliwych wariantów. Forma i treść raportu może w dużej mierze wynikać z różnych uwarunkować organizacyjnych i potrzeb projektowych.