Pracując w kilku firmach nad różnymi projektami, często brałem udział w ustalaniu sposobu dokumentowania tworzonych przez nas rozwiązań i metody wdrażania w firmie. Podczas tego typu rozmów prędzej czy później dochodzimy do tematu rysowania diagramów. Nie będę tu opisywał czy warto rysować diagramy, czy nie. Choć osobiście jestem ogromnym zwolennikiem myślenia wizualnego. Moje podejście możesz przeczytać w artykule [link później]. Jednak w kontekście rysowania diagramów najczęściej napotkamy dylemat. Czy standardy w rysowaniu diagramów są warte użycia, czy nie?

Standard pozwala utrzymać spójność pomiędzy zespołami

Jednym z największych plusów standardów jest ich spójność. Jeżeli jedna osoba tworzy diagramy zgodnie ze standardem, to inne osoby znające ten standard będą miały łatwość odnalezienia się w tym, co dany rysunek przedstawia. Dzięki temu niezależnie od tego, kto aktualnie będzie potrzebował określonej dokumentacji, każdy będzie w stanie szybko i sprawnie ją przeczytać.

Żeby rysować zgodnie ze standardem trzeba go znać

Tutaj jednak pojawia się problem. Żeby sprawnie operować danych standardem dokumentowania wizualnego (np. UML, BPMN) musimy znać ten standard i to dość dokładnie. Tym dokładniej, im więcej szczegółów chcemy zawrzeć na naszym obrazie. Również, żeby w pełni poprawnie odczytać dany diagram, musimy znać szczegóły danego standardu. Tak więc jesteśmy w stanie osiągnąć największe zyski z używania standardów tylko wtedy, gdy większość pracowników w naszej firmie dobrze je zna.

Standardy są obsługiwane przez większość narzędzi

Wyszkolenie wszystkich, aby znali standardy rysowania diagramów nie jest trudne. Dużo trudniejsze jest faktyczne egzekwowanie używania standardu w firmie. Na szczęście pomaga tu fakt, że standardy są szeroko wspierane przez różne narzędzia. Niektóre z nich pozwalają również wymusić używanie tylko standardowej notacji. Jednak nigdy nie zweryfikują, czy robimy to poprawnie.

Standard wymaga wielu szczegółów

W związku z tym często trafiają się sytuacje, że ludzie zamiast dokumentować wszystko zgodnie z przyjętymi standardami, idą na skróty. Nie byłoby to jeszcze problematyczne, gdyby nie to, że ludzie nie chodzą na skróty jedną drogą. Przez to dochodzimy do sytuacji, w której teoretycznie wszystkie diagramy w firmie są zgodne ze standardem, jednak na wiele sposobów się z nim rozmijają, co powoduje różnego rodzaju nieporozumienia wśród odbiorców.

Diagramy bez standardu są swobodniejsze

W przypadku zwykłych diagramów nie ma takiego ryzyka, bo ludzie siadając do ich analizy mają bardziej otwarta głowę. Dzięki temu różnice w notacjach lub wizualizacji nie są problemem. Każdy diagram jest niezależny i wymaga osobnego podejścia.

Diagramy bez standardu wymagają kliku słów komentarza

W związku z tym diagramy bez standardu zazwyczaj wymagają komentarza. Dzięki temu możemy wprowadzić odbiorcę w kontekst tego, co chcieliśmy opisać i na czym nam najbardziej zależało. Ma to szczególnie istotne znaczenie w przypadku bardziej skomplikowanych struktur. 

Standardy w rysowaniu diagramów ograniczają

W przypadku tych bardziej skomplikowanych struktur i koncepcji, które opisujemy, uwidacznia się największa zaleta nietrzymania się standardów. Nie jesteśmy ograniczeni określonym typem diagramu. Jeżeli na przykład do opisu przepływu akcji pomiędzy różnymi systemami podczas integracji zechcemy dodać warstwę danych, które przesyłamy, autoryzacji lub granic pomiędzy różnymi typami systemów, to nic nie stoi na przeszkodzie. Wystarczy dodać te kilka elementów i już będziemy mieli rozszerzony opis naszej sytuacji. To bardzo przydaje się, gdy rysujemy na bieżąco podczas omawiania danego zagadnienia (opisuję to w artykule []). Dzięki temu nie musimy się zastanawiać jakiej strzałki użyć, tylko rysujemy to tak jak nam wygodnie.

Diagramy bez standardów rysuje się szybciej

To kolejny plus swobodnych diagramów. Można je stworzyć dużo szybciej. Niejako w międzyczasie podczas dyskusji. W ten sposób niemal natychmiast po ustaleniu danego rozwiązania będziemy mieć gotową jego dokumentację. Korzystając ze standardów często musielibyśmy przerysować nasze diagramy odpowiednio, żeby spełniały wszystkie wymogi (czyli w praktyce ktoś musiałby wykonać dodatkową pracę). Jednak w życiu codziennym nie zawsze jest na to czas. Lepiej więc mieć gotowy luźny diagram, niż piękny, ustandaryzowany, który czeka na zrobienie.

Pasuje tu cytat: “Done is better than perfect”.

Wniosek

Standardy dokumentowania zdecydowanie warto znać. Warto również, żeby były one znane w naszym zespole. Jednak nie warto ich wymuszać. To często zabija kreatywność, a koszt tworzenia takich diagramów się nie zwraca.

Propozycja

Co warto wobec tego zrobić, żeby czerpać korzyści zarówno ze standardów jak i swobodnych diagramów?

Warto ustalić wewnętrzne standardy, jednak oparte na tym, co chcemy pokazać, a nie na tym w jaki sposób. Można powiedzieć, że będzie to nasza wspólna droga na skróty znana wszystkim, którzy z nami pracują. 

Dzięki temu będziemy w stanie tworzyć wartościowe diagramy w szybki i sprawny sposób.