Chciałbym poznać sposoby dokumentowania oprogramowania dla ludzi niezwiązanych z jego tworzeniem. Muszą tam być opisane wszystkie możliwości działania, np. jakie możliwości ma użytkownik typu A, użytkownik typu B, co w sytuacji kiedy nie ma połączenia z ERP, jaki komunikat kiedy użytkownik poda zły numer itd.
Rysowanie drzewka wypada średnio. A może jest jakieś narzędzie które samo coś wygeneruje na podstawie komentarzy w kodzie?
0
0
http://www.graphviz.org/
Ten program ma wbudowany kompilator języka dot służącego właśnie do takich grafów
Możesz też pisać normalnie w ide i tylko skompilować.
Nie wiem czy ide ma wtyczkę do czytania kodu dot z komentarzy, ale to też nie powinno być trudne do dopisania.
Możesz też użyć http://wavedrom.com/ jeżeli coś się ma dziać w czasie.
Wygenerowane tym diagramy możesz wyeksportować do svg lub innych i osadzić w pliku texa lub dowolnym innym.
Zalety są takie, że:
- Możesz to trzymać w gicie ze wszystkimi zaletami jakie git daje(a nie jak trzymanie w gicie biedałordzików)
- Po skompilowaniu z techa dostajesz pdf więc nie ma problemów, że gdzieś się rozjedzie
- Może nad tą dokumentacją pracować wiele osób jednocześnie.
Koniec końców niestety i tak jest wielka szansa, że trafisz na beton wymagający dokumentacji w łordziku pomimo tego, że i tak tej dokumentacji modyfikować nie będzie.
W sumie to przypomniaało mi sie jeszcze, że nawet jak na taki beton trafisz, to istnieje http://pandoc.org/index.html którym możesz skompilować MD lub TeX do łordzika.
0
Analiza Biznesowa, BPMN - chociaż tego biznes i tak nie rozumie, nawet nie chce zrozumieć.