Jak zaprzyjaźnić się z diagramami w dokumentacji?
Wiele osób ma problem z diagramami, często słyszę, że są niepotrzebne bo przecież „ten proces jest prosty – omówię Ci go”.
Dziś przedstawię Ci jeden z powodów, dla których diagramy są dla Ciebie trudne.
Powiem również co zrobić, aby rysować je z uśmiechem na pyniu 😉
Jak TO zrobić na diagramie?
Jak rozmawiam z czytelnikami i kursantami to zauważam, że największy problem z dokumentacją jest taki:
- Jak zacząć pisać, jaki powinien być spis treści – problem „pustej kartki” (nie wiadomo jak zacząć);
- Nie wiadomo JAK (ani JAKIE) rysować diagramy – dziś zajmiemy się właśnie drugim problemem.
Podejrzewam, że jeśli próbowałeś startować z diagramami to głównym pytaniem zadawanym sobie w głowie jest:
jak TO zrobić na tym diagramie?
*w miejsce „TO” – wstaw swoją funkcjonalność 🙂
Siedzimy nad diagramem, przerabiając go 15x, aż w końcu dochodzimy do wniosku, że „w sumie wszystko jedno gdzie to wrzucę bo pasuje wszędzie tak samo„.
Rozwiązanie tego problemu jest proste, ale trudne do zauważenia. Dlatego jeśli choć raz miałeś problem jak wyżej – zapraszam do czytania dalej 🙂
Diagramy są głupie 🙁
To, że nie wiemy jak je projektować powoduje, że frustrujemy się i „obrażamy na diagramy”.
Nikt nie lubi robić rzeczy, które są nieciekawe i trudne.
Dla mnie np. takim zadaniem jest rozliczenie miesiąca w software house. To dużo „papierkowej roboty”, sprawozdań i raportów. Uważam to za nudne i nie lubię tego robić.
Jednak z perspektywy zarządzania zespołami IT – jest to niezbędne żeby oceniać kondycje zespołu, organizacji i projektów. Bez tego się nie da.
Podobnie jest z diagramami – z nimi źle, bez nich jeszcze gorzej 😀
Wiedza o Dokumentacji IT na twój adres e-mail?
Cena (nie)robienia diagramów
W prostych projektach (ok. 1 miesiąc developmentu) może się udać bez diagramów. Przy małej skali dużo da się pokazać „machając rękoma przy tablicy” i powtarzając to samo kilku osobom.
Jednak przy projekcie średnim – zajedziemy się, jeśli nie będziemy trzymać się standardów i dobrych praktyk tworzenia dokumentacji.
Musisz mieć na uwadze, że czas nauki diagramów zwróci Ci się z nawiązką gdy zaczniesz je poprawnie używać.
Programiści ❤️ kochają diagramy, bo:
- są jednoznaczne
- można do nich wracać wielokrotnie (gdy ktoś opowiada to mamy jedną szansę zrozumienia)
- diagramy są spójne z resztą projektu – możemy skupić się na swojej części, mając pewność, że zrobimy ją dobrze
Ale przejdźmy do sedna… dlaczego niektórzy zadają sobie pytanie:
jak TO zrobić na diagramie?
Cel i zakres diagramu
Aby wyjaśnić Ci dlaczego masz trudność z diagramami – wrócę do początku.
Kluczowe jest zrozumienie CELU diagramu, którego używasz.
Częstym błędem jest to, że bierzemy np. diagram przypadków użycia, którego celem jest pokazać OGÓŁ PROJEKTU I JEGO SKALĘ… a my na tym diagramie staramy się zaprezentować proces rejestracji.
Dlatego robienie diagramów jest trudne – bo staramy się pokazać na diagramie rzeczy, do których NIE SŁUŻY.
To tak samo jakbyś próbował zjeść zupę przy pomocy… widelca. Na upartego by się dało, ale po co?
Poniżej prezentuję Ci ściągawkę gdybyś nie był biegły w diagramach. W pierwszej kolumnie jest jaki diagram, a w drugiej do jakich celów służy.
| Jaki Diagram? | Co pokazuje? |
| Diagram przypadków użycia | pokazanie kluczowych funkcjonalności (bez szczegółów), pokazanie ról projektowych (użytkownik, administrator itp) |
| Diagram czynności | procesy projektowe, kroki procesu, sekwencje czynności, zazębiające się czynności (KTO robi CO i KIEDY – jak to się ma względem reszty aplikacji?) |
| Diagram klas | właściwe rozumienie pojęć i zależności między nimi (co zawiera co, z czego składa się zamówienie etc). |
| Diagram stanów | jaki jest cykl życia w projekcie, np umowy, dokumentu |
| Diagram sieci projektu | kolejność wykonywania zadań projektowych |
O diagramach pisałem do Ciebie kilka miesięcy temu. Jeśli umknęło Ci to to zapoznaj się poniższymi:
Podsumowując, jeśli masz problem jak coś zawrzeć na diagramie, to zastanów się czy próbujesz to zobrazować na odpowiednim diagramie. Być może wybrałeś zły, który służy do zupełnie czegoś innego.
Zawsze warto dobierać rozwiązanie do problemu, zamiast rozwiązywać wszystkie problemy jednym rozwiązaniem.
Dziękuję, że przeczytałeś ❤️
Pssst... przygotowałem dla Ciebie kilka prezentów - wybierz co Ci się przyda! 👍
