Jako osoba zajmująca się szeroko rozumianą inżynierią oprogramowania często spotykam się z problemem automatycznego wygenerowania dokumentacji z Enterprise Architect. Raportowanie w Enterprise Architect to dość często stosowanie CTRL+C w Enterprise Architect a zaraz chwilę później CTRL+V w edytorze tekstu jest nagminne. Co tu dużo mówić lub pisać :-). Domyślne szablony dokumentacji, jakie oferuje Enterprise Architect są mało interesujące. Zbudowanie nowych, własnych jest dość kłopotliwe.
Drugi problem jest taki, że zazwyczaj użytkownicy raportują w następujący sposób. Na wybranym pakiecie repozytorium Enterprise Architect uruchamiany jest raport. Raport zbiera do raportu wszystko to co jest pod nim. Najwytrwalsi na tym samym pakiecie stosują dwa lub trzy raporty by w jednym zaraportować wymagania, w drugim przypadki użycia, itd.. a potem wszystko trafia do manualnej obróbki w Word.
Czy może być łatwiej?
W pewnym sensie tak. Trzeba jednak najpierw się napracować by potem można było tworzyć dokumentację automatycznie. Trzeba zbudować taki szablon, który w zależności od typu elementu zastosuje odpowiednie formatowanie. Taki mechanizm w Enterprise Architect nosi nazwę Template Selector – selektor szablonów.
Jak działa selektor szablonów. Zbudowanie takiego selektora wymaga:
- raportu głównego (klasyczny raport)
- raportu selekcjonującego (fragment z custom query)
- raportów opisujących dany artefakt (fragment klasyczny)
Raport główny
Raport główny zawiera w sobie tylko link do raportu selekcjonującego.
Natomiast Raport selekcjonujący składa się z pola custom
oraz odpowiedniego custom query. Sam selektor (custom query) jest zbudowany w dość prosty sposób. Najpierw jest typ elementu, następnie podwójny dwukropek a następnie wpisujemy nazwę szablonu typu fragment.
Raport opisujący dany artefakt jest już tradycyjnym fragmentem. W tym przypadku jest to szablon aktor, na który wskazuje selektor.
Zresztą zobacz jak taki raport zbudować na poniższym video, które jest lekcją 7 mojego internetowego kursu: Przygotowywanie raportów w Enterprise Architect. Film z krótkim spisem treści jest także na stronie kursu.
[video_embed url=”https://vimeo.com/232391072″]
Mam nadzieję, że teraz raportowanie w Enterprise Architect będzie dla Ciebie odrobinę przyjemniejsze :-).
A ja na to eaDocX? i wszystko jasne ?