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.

Jak to działa?

Załóżmy, że mamy plik w formacie MS Word zawierający wymagania w postaci:

• Identyfikator i nazwa wymagania
• Treść wymagania

Ważne jest to, żeby pola te były w osobnych akapitach, czyli były rozdzielone znakiem końca wiersza.

W ramach przykładu utworzyłem cztery wymagania, pierwsze dwa są w zapisane w formie zwykłych akapitów, a pozostałe zostały umieszczone w formie tabelarycznej. Aby poprawnie zadziałał import wymagań z tabeli konieczne jest umieszczenie znaku końca wiersza po nazwie wymagania.

W otwartym modelu Enterprise Architecta należy utworzyć nowy diagram typu Extended --> Requirement.

Magiczny sposób importu wymagań sprowadza się do:

• zaznaczenia całego wymagania (nazwy wraz z treścią),
• przeciągnięcia (drag & drop) zaznaczonego tekstu na diagram Enterprise Architecta.

Po przeciągnięciu na diagram pojawia się kontekstowe menu wyboru typu elementu, który ma zostać utworzony. Po wyborze typu Requirement tworzone jest i umieszczane na diagramie nowe wymaganie, którego nazwa (Short Description) odpowiada pierwszemu akapitowi, a pozostała treść (po znaku końca wiersza) umieszczana jest w polu opisu wymagania (Notes).

Wymagania utworzone w Enterprise Architect w niniejszym przykładzie pokazane są na powyższym rysunku.

Opisanej tu metodzie przeciągania treści z dokumentu MS Word wiele brakuje do jakiegoś zaawansowanego mechanizmu, ale nie można zaprzeczyć, że jest szybsza i wygodniejsza od zwykłego Copy&Paste. A w dodatku przeglądając pomoc lub dokumentację Enterprise Architecta trudno się dopatrzeć informacji o niej.