Temat: Generowana dokumentacja z VP

Jak radzicie sobie Państwo z generowaniem dokumentacji z VP? Mam kilka punktów, w których jednak VP przegrywa z MS Office Word. Może ktoś sobie z tym radzi lepiej i polega całkowicie na VP? :)

1. Brak polskich znaków w PDF. O ile przy generowaniu .docx czy .html można wybrać kodowanie, w PDFach nie widzę takiej opcji.

2. Wygenerowany .docx sypie błędami przy otwieraniu w Wordzie. Pojawiają się jakieś ostrzeżenia o niewłaściwym formacie treści, itd. Dopiero po ponownym zapisaniu już przez Worda, problemy się nie pojawiają.

3. Płaska struktura dokumentu. Z tego, co udało mi się ogarnąć narzędzie, generowanie dokumentacji następuje przez wybór diagramów. Jest to płaska lista, której nie można łączyć w grupy, zatem zamiast kilku punktów w specyfikacji, które wiążą się tematycznie, mam kilkanaście, kilkadziesiąt punktów, gdzie na jednym poziomie występują i procesy biznesowe, i wymagania, i przypadki użycia, itd. Takie ułożenie przytłacza i daje czytelnikom efekt nieczytelności. Zamiast bardziej pragnąć czytać specyfikację, zostają niestety odstraszeni.

4. Małe diagramy. Po narysowaniu diagramu, który rozciąga się choć odrobinę poza obszar widoczności, dostajemy taki diagram, który nawet przy powiększeniu dokumentu do 500% potrafi być w .docx nie do rozczytania. Pozostają małe diagramy lub przerzucanie screenów do Worda?

5. Spis treści nieczytelny lub nie na miejscu. Bardzo cenię sobie spis treści dokumentu w Wordzie, który zawsze mam z prawej strony i jest pod ręką. Przy większych dokumentach to prawdziwy skarb. Niestety w dokumentacji VP dostajemy ten spis treści z samymi nazwami kolejnych diagramów i ich elementów. Nie pomaga to się sprawniej poruszać. W HTML przydałby się spis treści w bocznej kolumnie. Trzeba ręcznie grzebać w szablonie strony czy jest jakiś sprytniejszy sposób?

6. Szczegóły bez opisów. Czy jest możliwość pokazywania szczegółów przypadków użycia i jednoczesne niepokazywanie szczegółów innych diagramów, które i tak nie są opisane?

Temat: Generowana dokumentacja z VP

Hanna W.:
Jak radzicie sobie Państwo z generowaniem dokumentacji z VP? Mam kilka punktów, w których jednak VP przegrywa z MS Office Word. Może ktoś sobie z tym radzi lepiej i polega całkowicie na VP? :)

1. Brak polskich znaków w PDF. O ile przy generowaniu .docx czy .html można wybrać kodowanie, w PDFach nie widzę takiej opcji.

są polskie znaki w PDF, należy wybrać odpowiednia czcionkę np. Arial

2. Wygenerowany .docx sypie błędami przy otwieraniu w Wordzie. Pojawiają się jakieś ostrzeżenia o niewłaściwym formacie treści, itd. Dopiero po ponownym zapisaniu już przez Worda, problemy się nie pojawiają.

u siebie nie obserwuje tego...

3. Płaska struktura dokumentu. Z tego, co udało mi się ogarnąć narzędzie, generowanie dokumentacji następuje przez wybór diagramów. Jest to płaska lista, której nie można łączyć w grupy, zatem zamiast kilku punktów w specyfikacji, które wiążą się tematycznie, mam kilkanaście, kilkadziesiąt punktów, gdzie na jednym poziomie występują i procesy biznesowe, i wymagania, i przypadki użycia, itd. Takie ułożenie przytłacza i daje czytelnikom efekt nieczytelności. Zamiast bardziej pragnąć czytać specyfikację, zostają niestety odstraszeni.

hm... standardowo raport generuje faktycznie płaski plik jako kolejne diagramy z opisami. To chyba efekt tego, że tak są pisane często nawet anglosaskie podręczniki. Częściowym rozwiązaniem problemu jest korzystanie z diagramów poglądowych, które po pierwsze porządkują tworzone modele (dokumentują ich strukturę) i mogą stanowić śródtytuły dokumentacji (ja np. ich nazwy pisze kapitalikami to od razu rzuca sie w oczy w spisie treści).

4. Małe diagramy. Po narysowaniu diagramu, który rozciąga się choć odrobinę poza obszar widoczności, dostajemy taki diagram, który nawet przy powiększeniu dokumentu do 500% potrafi być w .docx nie do rozczytania. Pozostają małe diagramy lub przerzucanie screenów do Worda?

warto deklarować grafikę jako obiektową (SVG) wtedy daje sie powiększać. Druga rada, spotykana także w literaturze - zaleca się na jeden diagram przypadął ok. 7 +/- 2 "grube" elementy. (diagramy nie powinny być zbyt mocno "naćkane"...

5. Spis treści nieczytelny lub nie na miejscu. Bardzo cenię sobie spis treści dokumentu w Wordzie, który zawsze mam z prawej strony i jest pod ręką. Przy większych dokumentach to prawdziwy skarb. Niestety w dokumentacji VP dostajemy ten spis treści z samymi nazwami kolejnych diagramów i ich elementów. Nie pomaga to się sprawniej poruszać. W HTML przydałby się spis treści w bocznej kolumnie. Trzeba ręcznie grzebać w szablonie strony czy jest jakiś sprytniejszy sposób?

sama praca w VP jest łatwa z użyciem Ctrl+F Ctrl+Shift+J, co znaczy "spis treści nie na miejscu?

6. Szczegóły bez opisów. Czy jest możliwość pokazywania szczegółów przypadków użycia i jednoczesne niepokazywanie szczegółów innych diagramów, które i tak nie są opisane?

no to fakt bywa problemem, pewnym rozwiązaniem jest stworzenie samemu szablonu raportu jako pliki XML

Temat: Generowana dokumentacja z VP

Ponieważ Jarek napisał już sporo, to ja tylko kilka dodatkowych uwag:

Hanna W.:
3. Płaska struktura dokumentu. Z tego, co udało mi się ogarnąć narzędzie, generowanie dokumentacji następuje przez wybór diagramów. Jest to płaska lista, której nie można łączyć w grupy, zatem zamiast kilku punktów w specyfikacji, które wiążą się tematycznie, mam kilkanaście, kilkadziesiąt punktów, gdzie na jednym poziomie występują i procesy biznesowe, i wymagania, i przypadki użycia, itd. Takie ułożenie przytłacza i daje czytelnikom efekt nieczytelności. Zamiast bardziej pragnąć czytać specyfikację, zostają niestety odstraszeni.

Jest darmowa wtyczka dostarczana przez Visual Paradigm - nazywa się Report Writer - otwiera się okno z uproszczonym interfejsem Word/OpenOffice i możliwościa "wyciągania" poszczególnych elementów modelu, które są automatycznie wizualizowane jako diagramy lub stosowne tabele.

5. Spis treści nieczytelny lub nie na miejscu. Bardzo cenię sobie spis treści dokumentu w Wordzie, który zawsze mam z prawej strony i jest pod ręką. Przy większych dokumentach to prawdziwy skarb. Niestety w dokumentacji VP dostajemy ten spis treści z samymi nazwami kolejnych diagramów i ich elementów. Nie pomaga to się sprawniej poruszać. W HTML przydałby się spis treści w bocznej kolumnie. Trzeba ręcznie grzebać w szablonie strony czy jest jakiś sprytniejszy sposób?

W Report Writerze można zrobić własne spisy AFAIRC

6. Szczegóły bez opisów. Czy jest możliwość pokazywania szczegółów przypadków użycia i jednoczesne niepokazywanie szczegółów innych diagramów, które i tak nie są opisane?

Report Writer again:)

Temat: Generowana dokumentacja z VP

Pięknie dziękuję Panom za rady. Wszystkie podziałały :)

Temat: Generowana dokumentacja z VP

Tu wskazówki jak sobie można dostosować raporty (diagram report)
http://www.visual-paradigm.com/product/vpuml/tutorials...

Temat: Generowana dokumentacja z VP

Jetem początkującym użytkownikiem wersji SE 12. Staram się wygenerować dokument w postaci docx z diagramu (biznes proces, data flow). Utworzyłem i skonfigurowałem w tym celu szablony. Generalnie wszystko jest w porządku. Tworzę dokument z wybranymi elementami diagramu oraz ich opisami. Mam jednak problem z sortowaniem. Jedyne ustawienie jakie znalazłem sortuje w ramach poszczególnych elementów szablonu po nazwie lub typie. Chciałbym wymusić sort aby ułożyć elementy dokumentu zgodnie z przyjęta logiką np. wg kolejności wykonywania czynności na diagramie ...
Możecie coś doradzić w tym temacie?