Eksport danych z MS Word do EA

Enterprise Architect jest postrzegany jako świetne narzędzie do wsparcia projektów informatycznych. Jednakże jedną z jego wad jest niedostateczna ilość narzędzi, które pozwalają wymieniać dane z innymi narzędziami. W zdecydowanej większości przypadków istnieje i będzie istnieć konieczność obiegu dokumentów w formacie MS Word.

Często mamy do czynienia z dokumentami w formacie MS Word, które opracował klient lub członkowie zespołu projektowego, a treść takiego dokumentu powinna zostać umieszczona w repozytorium programu Enterprise Architect. Cóż pozostaje zrobić w takim przypadku?
Możliwe jest wykorzystanie prostego zabiegu, który opisałem w artykule Import wymagań z MS Word. Jednak nie jest to rozwiązanie satysfakcjonujące. Zatem najczęściej treść dokumentu jest po prostu skrupulatnie przepisywana.

Na szczęście społeczność użytkowników EA jest duża i można liczyć na wsparcie z ich strony. W sieci pojawiła się nowa strona: www.eawordimporter.com. Znaleźć tam można darmowe narzędzie o wiele mówiącej nazwie: EA Word Importer.

Do czego warto zastosować to narzędzie:

• import wymagań,
• import przypadków użycia,
• import przypadków testowych

Podstawowe korzyści to:

• oszczędność czasu - eliminacja potrzeby ręcznego przepisywania tekstu
• ograniczenie ryzyka pomyłek przy ręcznej edycji tekstu
• możliwość śledzenia zależności pomiędzy zaimportowanymi elementami
• wykorzystanie centra

Na początek polecam obejrzenie krótkiego filmu prezentującego ideę, jaka przyświecała twórcom: https://www.youtube.com/watch?v=caoJCVQHv2I.

Jak przenieść scenariusz do innego przypadku użycia?

W trakcie pracy nad modelem użycia często dochodzi do sytuacji, w której analityk dochodzi do wniosku, że określony scenariusz należy przenieść z jednego przypadku użycia do innego. Może tak się zdarzyć, gdy okazuje się, że scenariusz alternatywny powinien rozwidlać się jeszcze bardziej, czyli mieć jeszcze dodatkowe alternatywy.
Czasem istnieje również potrzeba stworzenia nowego przypadku użycia podobnego do już istniejącego, na przykład, gdy tworzymy kolejną specjalizację przypadku generalizującego.
Gdyby scenariusze pisane były w zwykłym dokumencie MS Word, wówczas przeniesienie czy skopiowanie kroków scenariusza byłoby banalne. Jednak jeśli zdecydowaliśmy się na zastosowanie ustrukturalizowanych scenariuszy (Structured scenario), wówczas staje się to problematyczne.
Na szczęście istnieje rozwiązanie...

Jak dodać obrazek do modelu?

Czasami zachodzi potrzeba wzbogacenia diagramów tworzonych w programie Enterprise Architect o elementy graficzne. Na przykład na stronie startowej można umieścić logo organizacji, na diagramie opisującym lokalizacje - zamienić zwykłe prostokąty na symbole budynków albo na diagramie typu deployment zamienić device na symbol routera.

Poniższy rysunek prezentuje przykład diagramu wzbogaconego o elementy graficzne.

Komponent o nazwie Klient EA 1 oraz Klient EA 2 reprezentują aplikacje klienckie Enterprise Architect zainstalowane na stacjach roboczych.

Biblioteka dokumentów w EA

W artykule Import wymagań z Linked Document opisałem mechanizm tworzenia elementów modelu wprost z dokumentów składowanych w modelu w formie Linked Documents. Wykorzystanie tego mechanizmu wymaga zaimportowania dokumentów do modelu i przypisanie ich do określonych elementów typu <<document>>. Proces taki wymaga pewnego nakładu sił, co w przypadku dużych projektów może być kłopotliwe, a poza tym użytkownicy modelu i tak mają świadomość, że dokumenty te są tylko kopią dokumentów składowanych poza modelem. Aby mieć pewność, że sięgają do właściwej treści użytkownicy i tak będą korzystać z referencyjnego repozytorium dokumentów, jakim może być np. Sharepoint lub SVN.

Zatem po co tworzyć bibliotekę dokumentów w modelu Enterprise Architect?

Mogą istnieć różne przesłanki wynikające ze specyfiki projektów. Z analitycznego punktu widzenia  wartość dodaną stanowi możliwość tworzenia relacji dokumentów do innych elementów modelu (np. Dependency, Trace) oraz możliwość łączenia poprzez hiperłącza określonych słów czy fraz z dokumentu.
Ponadto model dokumentacji może służyć do wspomagania procesów tworzenia dokumentacji projektowej poprzez zastosowanie diagramów i relacji pomiędzy dokumentami. Na przykład można zamodelować zależności prezentujące informacje o tym, który dokument (lub rozdział) wynika z jakiegoś innego dokumentu. Dzięki temu łatwiej zorientować się, czy aktualizacja jednego dokumentu pociąga za sobą konieczność aktualizacji innego dokumentu.

Import wymagań z MS Excel

W artykule Import wymagań z MS Word opisałem prostą metodę usprawniającą kopiowanie treści z edytora tekstu. Zasugerowałem, że można to wykorzystać do importu wymagań. Zaznaczyłem, że ta metoda jest przydatna, gdy dysponujemy bardzo ograniczonym czasem na wykonanie zadania. Jeśli jednak stać nas na solidne przygotowanie warsztatu pracy, spróbujmy wykorzystać VBA (Visual Basic for Applications) w MS Excel i opracujmy swój własny importer wymagań.
Zacznijmy jednak od początku...

Dlaczego mowa o imporcie wymagań?

Dlaczego mechanizmy importu zawężam tylko do wymagań, podczas gdy mechanizmy te są uniwersalne i umożliwiają importowanie elementów dowolnego typu?
Rzeczywiście można importować rozmaitego rodzaju treść do Enterprise Architect. Ja sam importowałem np. przypadki testowe, procesy biznesowe, komponenty aplikacyjne czy też urządzenia. Z punktu widzenia swojej praktyki w wielu projektach zauważam, że najczęściej potrzebny jest jednak właśnie import wymagań.
Wynika to z tego, że zanim wymagania zostaną udokumentowane, konieczne jest ustalenie ich zakresu. Treść wymagań ustala się wraz z klientem podczas spotkań lub poprzez wymianę uwag i odpowiadanie na uwagi w formie pisemnej.
Nie wyobrażam sobie, aby użytkownik z działu merytorycznego korzystał z repozytorium w narzędziu Enterprise Architect do przeglądania i czytania propozycji wymagań. Podobnie nie wyobrażam sobie edycji treści wymagań na spotkaniu bezpośrednio w Enterprise Architect.
Uważam, że do wymiany informacji z klientem, zwłaszcza z użytkownikiem merytorycznym powinny służyć dokumenty w formacie MS Word i MS Excel, gdyż są osoby merytoryczne czują się swobodnie korzystając z tych programów. W takim układzie potrzebne są mechanizmy zarówno do importu treści do modelu Enterprise Architect, jak i mechanizmy eksportu (np. raportowanie), dzięki którym będziemy w stanie "przerzucić" treści w drugą stronę.

Import wymagań z MS Word

W przypadku, gdy w projekcie podjęto decyzję o zarządzaniu i dokumentowaniu wymagań w oparciu o narzędzie Sparx Enterprise Architect zazwyczaj dochodzi do sytuacji, że zestaw wymagań zostaje wypracowany w jakimś innym narzędziu. Najczęściej wymagania dokumentowane są przy użyciu programu MS Word lub MS Excel.
Jest to naturalna sytuacja, gdyż wymagania są opisywane przy użyciu języka naturalnego oraz zachodzi konieczność łatwego komunikowania ich klientowi. Poprawki w treści wymagań często są nanoszone w trakcie spotkań z klientem, bądź przesyłane pocztą elektroniczną. Zastosowanie do tego celu programu MS Word wydaje się najlepszym rozwiązaniem, zwłaszcza gdy w grę wchodzi wykorzystanie trybu rejestracji zmian w MS Word.
Problem zaczyna się, gdy uzgodnioną już treść wymagań należy przenieść do Enterprise Architecta. Gdy wymagań jest niewiele, możliwe jest ich manualne przekopiowanie, jednak w złożonym projekcie wymagań bywa ich kilkaset lub kilka tysięcy. W dodatku w praktyce czas na stworzenie rejestru wymagań w modelu Enterprise Architecta jest bardzo ograniczony, gdyż ważniejszym zadaniem jest zapewnienie określonej wartości merytorycznej artefaktów, niż ich forma.
W niniejszym artykule opisane zostało ułatwienie w przenoszeniu treści wymagań z MS Word. Już na początku chcę wyraźnie zaznaczyć, że nie jest to preferowana przeze mnie metoda. Jeśli to jest możliwe, to zalecam importowanie wymagań przy wykorzystaniu makra w Visual Basicu w programie MS Excel. Opiszę tę metodę przy innej okazji.
Wracając do importu wymagań z MS Word, jej największą zaletą jest prostota. Poza tym nie jest potrzebne opracowywanie jakiegokolwiek narzędzia czy interfejsu do MS Office.