Jak tworzyć czytelny model?

Pracując, jako Analityk czasami spotykam się z procesami, opisami infrastruktury i diagramami dziedziny w postaci modeli. Często są one świetnie zrobione, czasami nieco mniej, lecz od czasu do czasu pojawiają się pewne potworki. Potworki, które skłaniają człowieka do zakupu plotera, innej wielkoformatowej drukarki lub 50-calowego monitora z wysoką rozdzielczością. Zdarza się tak, że poza rozmiarem model zaskakuje kreatywnością lub lekkim bałaganem twórczym.

Rozmawiając ze znajomym po fachu, doszliśmy do wniosku, że warto zebrać dobre praktyki w jednym miejscu. Nakierują one jak budować czytelne modele. W tym artykule poznasz kilka zasad zebranych ze świata analizy i naszych doświadczeń pracy z modelami.

Złota rada

Zanim zaczniesz tworzyć jakiekolwiek modele, zderz oczekiwania twoich odbiorców z tym, co chcesz tworzyć. Sprawdź, jaką mają wiedzę, czego oczekują od Ciebie, jakie są standardy organizacyjne, ustal jaki poziom szczegółowości będzie cechować twoje modele oraz jakie jest ich przeznaczenie. Każdy odbiorca może wymagać czegoś innego. Musisz znaleźć wtedy złoty środek. Pamiętaj, że celem modelowania jest poprawa komunikacji z odbiorcami naszej dokumentacji i ułatwienie nam pracy, poprzez graficzną reprezentację zebranych wymagań, wiedzy i oczekiwań.

Odpowiednia notacja i typ diagramu

Kiedy dowiesz się, czego od Ciebie oczekują, musisz dobrać odpowiednią notację, która ułatwi Ci pracę i poprawi waszą komunikację. Zaplanowanie, z czego będziesz korzystał, może być kluczowe. Zaoszczędzi Ci w przyszłości wiele pracy. Zapewne przyznasz, że modelowanie złożonych procesów biznesowych za pomocą flowchartu nie należy do najprzyjemniejszych.

Dobór narzędzi może okazać się niełatwy, ale warto poświęcić na to nieco czasu. Gdy już to zrobisz, zapisz sobie, z czego i gdzie korzystasz, aby zachować spójność przez cały okres analizy.

Zgodnie z zasadami

Wybór notacji daje nam gotowe wzorce, ale również nakłada na nas obowiązek jej znajomości oraz przestrzegania ustalonych w niej zasad. Zapewniają one rozumienie tych samych elementów w ten sam sposób przez wiele osób.

Jeżeli wybrany typ diagramu z notacji nie pozwala na przekazanie Twojego celu lub nie wiesz jak go użyć, zmień go. Jeżeli nie znasz lub nie wiesz czego użyć, zawsze możesz stworzyć swoją notację, aczkolwiek pamiętaj aby zawsze załączyć opis jak ją czytać i rozumieć.

Mniej znaczy czytelniej

Stworzenie wielkiego modelu, który opisuje cały świat, może być kuszące. Stworzenie go spowoduje poczucie posiadania pewnej siły i mocy sprawczej. Przy czym czytelność dla odbiorcy czy jego utrzymanie może być trudne, o ile w ogóle możliwe. Osobiście często spotykam się z takimi diagramami i nigdy nie da się z nich skorzystać, w dodatku pomijają mnóstwo kluczowych aspektów.

Opracowywanie mniejszych modeli pozwala na uproszczenie ich struktury, skraca czas poświęcony na modyfikację czy utrzymywanie. Dodatkowo dekompozycja procesu na podprocesy wymusza tworzenie modeli z perspektywy danego kawałka procesu, co pozwala na identyfikację większej liczby szczegółów.

Podczas modelowania diagramu warto wziąć pod uwagę to, jak zostanie on przekazany odbiorcy. Przekazanie w formie wydruku na A4 może znacznie wpłynąć na maksymalną liczbę elementów w modelu.

Lewo-> Prawo, Góra-> Dół

Ustal kierunek, w którym tworzysz diagram aby zawsze wiedzieć gdzie szukać początku oraz gdzie następnie kierować swój wzrok.

Ciężko czytać diagramy, w których diagram co chwilę skręca i nie ma wyznaczonego kierunku czytania. Wybranie jednego kierunku tworzenia diagramu (zwłaszcza przy procesach) ułatwi czytanie przez odbiorcę oraz Tobie pracę. Dobrze jest wybrać kierunek zgodnie z wektorem pisania od lewej do prawej lub ewentualnie z góry do dołu.

Pion i Poziom

Z początku wydaję się to niezbyt istotne, by linie na diagramie przebiegały PIONOWO lub POZIOMO, lecz zastosowanie wszystkich strzałek w tych kierunkach i powstałe w wyniku tego kąty proste sprawiają, że diagram wygląda bardzo estetycznie.

Jeżeli pracujesz w narzędziu do modelowania, takim jak np. Enterprise Architect warto wybrać taki styl lini (Tree lub Lateral), ponieważ zyskujesz przewidywalny sposób zachowania się wszelkich relacji.

Wyjątkiem od tej reguły (jak dla mnie) są połączenia do notatek i relacje w diagramie przypadków użycia. Z nieznanego mi powodu wyglądają lepiej w postaci prostych linii (Direct).

Nie przecinaj i uporządkuj

Ciężko jest czytać diagramy, kiedy jest w nich nieporządek i relacje między elementami się przecinają.

Podczas tworzenia diagramów uporządkuj na nich relacje. Powyżej mamy przykładowy prosty model, który pokazuje ten problem. Odczytanie relacji między Siedzibą firmy a Służbowym pokojem jest ciężkie oraz nie widać tej relacji na pierwszy rzut oka. Jeżeli nie jesteś w stanie uporządkować na nim relacji, zastanów się nad poziomem szczegółowości tego diagramu. Może powinieneś podzielić model na kilka mniejszych, a zatem bardziej czytelnych.

Uporządkowany diagram dużo łatwiej jest analizować i pozwala na szybsze wyłapanie ewentualnych braków lub błędów. Jeżeli będziesz utrzymywać, w tym zakresie porządek również będzie się lepiej pracować. Odpowiednio zaplanowany model z wyrównanymi i dopasowanymi rozmiarami elementami oraz relacjami poprowadzonymi w przemyślany sposób pozwoli na lepszy odbiór Twojej analizy.W wypadku, gdy nie jesteś w stanie poprowadzić relacji tak, aby była ona czytelna i nie przecinała innych elementów, rozważ zastosowanie dodatkowych elementów, które istnieją w ramach notacji. Przykładem takiego elementu jest Łącze (Link) w BPMN, które pozwala nam przerwać proces w jednym miejscu i rozpocząć go w kolejnym.

Stosowanie tego typu elementów pozwala również na zarządzanie wolną przestrzenią, która negatywnie wpływa na wygląd i czytelność modelu.

Ważniejsze wyżej

Jeżeli stosujesz rodzaj diagramu, w którym ważna jest hierarchia umieść ważniejsze elementy wyżej. Odpowiednie ułożenie elementów ułatwi zrozumienie zależności pomiędzy elementami, ponieważ z nieznanych powodów im niżej coś ważniejszego umieścimy tym ciężej jest nam zrozumieć, że jest to faktycznie ważniejsze.

Kolory

Warto używać na diagramie różnych kolorów. Korzystam z nich po to, aby wskazać pewne dodatkowe informacje na diagramie. Odznaczenie np. Happy flow innym kolorem czy zaznaczenie np. elementów wymagających zmiany (Jak na przykład rozróżnienie nowych komponentów od istniejących) ułatwia zrozumienie modelu.

Podsumowanie

Wszystkie powyższe zasady są ważne i warto je wdrażać do swojej codziennej pracy. Należy pamiętać, że stosowanie tych zasad pomaga w zrozumieniu modeli, ale nie weryfikuje ich zgodności z rzeczywistością lub zebranymi wymaganiami.
Stosując te zasady ZYSKASZ:

1. Pozytywny odbiór owoców twojej pracy przez interesariuszy. 
2. Czas, który poświęcasz na wyjaśnianie złożonych diagramów.
3. Czas, który poświęcasz na edycję modeli.
4. Spokój, który tracisz przy edycji potworków.
5. Oszczędność pieniędzy, które musiałbyś zapłacić za 50-calowy monitor.

Powodzenia!

PS: Za wsparcie merytoryczne oraz redakcyjne, a także pomysł na artykuł dziękuję Grzegorzowi W.!
PS2: Prezent od Grzegorza INFOGRAFIKA DOBRYCH PRAKTYK

Bibliografia

1. https://www.smartdraw.com/flowchart/flowchart-tips.htm [Dostęp 22.04.2020r)
2. https://bellekens.com/2012/02/21/uml-best-practice-5-rules-for-better-uml-diagrams [Dostęp 22.04.2020r]
3. https://www.lucidchart.com/blog/3-tips-for-wow-worthy-diagrams[Dostęp 22.04.2020r]
4. https://www.edrawsoft.com/diagramming-tips.html [Dostęp 22.04.2020r]
5. https://4ba.pl/modelowanie-w-analizie-biznesowej/ [Dostęp 26.04.2020r]
6. https://wolski.pro/2017/02/kiedy-jest-warto-modelowac-w-uml/ [Dostęp 26.04.2020r]
7. http://www.redpill.com.pl/pl/artykuly/akademia/113-dziedzina [Dostęp 26.04.2020r]