Adresaci diagramów

Gdy tworzymy diagramy zazwyczaj skupiamy się na tym, aby wiernie odzwierciedlić rzeczywistość zgodnie z regułami zastosowanej notacji. Jednakże to nie jest wystarczające do tego, aby zostały poprawnie zrozumiane przez adresatów.

Czy zastanawialiście się nad tym, komu i do czego opracowywane diagramy mają służyć?

Zanim zaczniemy opracowywać diagramy, powinniśmy postawić się w roli adresata diagramów i spróbować sobie odpowiedzieć na poniższe pytania.

Kto będzie czytać diagramy?

Ogólnie rzecz ujmując, diagramy są czytane przez interesariuszy (stakeholders). Mamy do czynienia z różnymi grupami interesariuszy. 

Adresatem może być przedstawiciel klienta, zarówno po stronie biznesu, jak i IT. Adresatem może być również kierownik projektu, architekt, programista, tester, wdrożeniowiec itd.
W związku z tym, na przykład diagramy opracowywane dla adresatów technicznych mogą być nasycone technikaliami, a diagramy skierowane do osób z biznesu powinny być pozbawione technikaliów, ale mogą zawierać terminy branżowe.

Dlaczego będzie je czytać?

Wyjaśnienie, że adresat powinien zaakceptować dokument nie jest wystarczające. Istotne za to jest wyjaśnienie z punktu widzenia adresata. 

Na przykład przedstawiciel klienta będzie czytać diagram, aby upewnić się, że proponowane rozwiązanie uwzględnia wszystkie zgłoszone wymagania oraz że wymagania te zostały poprawnie zrozumiane przez wykonawcę. Tester będzie chciał się upewnić, że będzie w stanie zbudować pełną listę scenariuszy i przypadków testowych. Programista będzie chciał się upewnić, że posiada pełen zakres informacji o tym, co ma zakodować.

Jaki jest przekaz diagramu?

Ogólnie mówi się, że jeden obraz wart jest tysiąca słów. Owszem, jeśli mamy za zadanie wytłumaczyć komuś, co przedstawia diagram, wówczas możemy długo opowiadać. Ale te przysłowiowe "tysiąc słów" to tylko opis jakiegoś zagadnienia czy problemu. Jeden diagram powinien nieść ze sobą jakieś przesłanie.

Spróbujmy się zastanowić, jak sformułować takie przesłanie... 

Może to być na przykład: 

• "to jest przedstawienie wszystkich encji danych powiązanych z kontem klienta",
• "to są wszystkie funkcjonalności przypisane do klienta w naszym systemie",
• "to jest sposób, w jaki nasz system komunikuje się z systemami zewnętrznymi".

Jedni z interesariuszy będą zainteresowani bardziej ogólnymi zagadnieniami, a inni będą wymagać informacji bardziej szczegółowych. Przekaz diagramu powinien być dostosowany do oczekiwań.

Gdzie diagram będzie czytany?

Diagramy mogą być dostarczane adresatom na różne sposoby:

• wprost w narzędziu CASE, np. Enterprise Architect,
• w formie raportu RTF,
• w formie raportu HTML,
• w formie pliku graficznego.

Członkowie zespołu projektowego tacy, jak analitycy, architekci czy programiści najczęściej będą korzystać z narzędzia typu CASE. Klient może czytać diagramy dołączone do dokumentacji w postaci raportu w MS Word, czy też w przeglądarce internetowej. A kierownictwo może sporadycznie korzystać z wybranych diagramów i dlatego może im wystarczać na przykład wyeksportowany plik graficzny.

Z każdym z tych sposobów wiążą się pewne ograniczenia. Duży diagram wklejony do dokumentu MS Word może być nieczytelny, dlatego też warto duże diagramy rozbijać na wiele mniejszych, aby poprawić czytelność. Diagramy w postaci raportu HTML mogą być wyposażone w hiperłącza ułatwiające nawigację w ramach modelu. Na diagramach, które z założenia będą czytane wprost w narzędziu CASE można nie umieszczać wszystkich szczegółowych informacji, gdyż czytelnik może do nich dotrzeć poprzez okno właściwości elementu lub relacji.

Jakie umiejętności są potrzebne do czytania diagramu?

Różne grupy interesariuszy posiadają różne umiejętności potrzebne do czytania diagramów. Przedstawiciel biznesu może nie wiedzieć, że owal reprezentuje przypadek użycia, albo który segment klasy UML zawiera atrybuty, a który metody. Ale te pojęcia będą bliższe adresatom technicznym.

Warto, o ile to możliwe, ustalić na wstępnym etapie z interesariuszami konwencję graficzną, która będzie dla nich czytelna.

Kiedy diagram będzie czytany?

Określone typy diagramów mają znaczenie na różnych etapach przedsięwzięcia. Należy dostarczać diagramy interesariuszom wtedy, gdy są dla nich istotne i są oni w stanie zweryfikować je w odniesieniu do innych artefaktów projektowych. Warto również brać pod uwagę to, czy dany diagram będzie miał znaczenie tylko na etapie budowania rozwiązania, czy również na etapie utrzymania, dalszego rozwoju itd.