Wiele osób musi skomentować dokumentację z Enterprise Architect

W wielu projektach zdarza się , że dokument wygenerowany z Enterprise Architect musi przeczytać i skomentować kilka czasem (znam skrajny przypadek)kilkanaście osób. Sekwencyjne wysyłanie dokumentów do opiniowania jest raczej mało sensowne a na pewno czasochłonne.  W takiej sytuacji staram się używać Google Docs. Zapisanie artefaktu w Google Docs ma dwie zalety. Plik jest od razu zapisany w chmurze (co jest modne ale też wygodne) i mogę wysłać do współpracowników  link z zaproszeniem do komentowania – i taką też opcją w uprawnieniach. Nie zapycham poczty plikami. Wszystkie komentarze są automatycznie widoczne dla wszystkich innych komentujących i nie problemu ze scaleniem tych treści.  Oczywiście nie ma róży bez kolcy…

O ile samo komentowanie jest proste

image

a komentarze jednoznacznie wskazują na miejsce opisu 

image

oraz pozwalają na prowadzenie dyskusji to niestety domyślenie wygenerowana dokumentacja z Enterprise Architecta nie będzie poprawnie zaimportowana do Google Docs. Problem jest z obrazkami. Otóż domyślny format nie jest konwertowany i trzeba go zmienić na bitmapę. Wystarczy tylko w szablonie dokumentu wybrać format bitmapy. Zmienia się to w następujący sposób: Na początku trzeba wyświetlić dialog  Generate RTF Documentation  – klawisz F8 na dowolnym pakiecie. Następnie należy wybrać na zakładce Advanced przycisk Switch generator i jest już się w zaawansowanych ustawieniach dokumentu. Potem tylko zmiana elementu (zaznaczyłem strzałką) i już jest OK.

image

Problem z obrazkami rozwiązany. Druga trudność to wielkość plików. Domyślny RTF może być zabójczy dla Google Docs. Stąd też proponuję zapisanie pliku w formacie .docx a potem przy importowaniu do Google Docs konwersję do formatu Google. Przykładowy plik (a raczej link) poniżej.

Ważne jest to, że przy udostępnianiu pliku należy wymagać iż osoby muszą być zalogowane. Dwa powody są ku temu. Pierwszy to bezpieczeństwo projektu i dokumentacji. Nie widzę powodu by każdy miał dostęp do wytwarzanej dokumentacji. Drugi to komentarze. Gdy pozwolimy na komentarze bez opcji zalogowania (powyższy link  jest właśnie do takiego dokumentu) to komentarze będą pochodzić od anonima:

image

co raczej jest kiepskim pomysłem.

Jeśli masz jakiś inny sposób na szybki przegląd dokumentacji podziel się nim w komentarzach.

Podobne wpisy
Zintegrowane środowisko wytwarzania aplikacji web’owych na platformie .NET

W artykule przedstawiono opis pakietu narzędziowego VS.NET (Microsoft) z Rational XDE (IBM) do wytwarzania aplikacji webowych pracujących w środowisku urządzeń więcej

Rational Software Architect Pierwszy Krok

Technorati Tagi: Rational Software Architect,inżynieria oprogramowania W artykule zaprezentowano jak rozpocząć pracę z i opis elementów tego narzędzia CASE. Środowisko więcej

Wstęp do projektowania aplikacji w Rational Software Architect

Rational Software Architect jest kolejną po Rational Rose i Rational XDE generacją narzędzi wspierających twórców oprogramowania w czasie projektowania. RSA więcej

Rational Unified Process – Wstęp

Rational Unified Process jest zunifikowanym procesem wytwórczym oprogramowania dostarczającym praktycznych wskazówek, wzorców dokumentów i narzędzi, szablonów dokumentów oraz przykładów postępowania więcej

Reklama
MODESTO - licencje Enterprise Architect

2 komentarze dla “Wiele osób musi skomentować dokumentację z Enterprise Architect”

  1. Witam, jak ma się wykorzystywanie gdocs do publikacji dokumentów, które dotyczą np. pewnych procedur w firmach ? Jak wiadomo publikacje tego typu dokumentów nie powinny wypływać do strumieni ogólnodostępnych np. mówią o tym wymogi biura bezpieczeństwa danej firmy. Pytanie czy wrzucanie do gd dokumentów i nadanie uprawnień tylko odpowiednim userom jest dobrą praktyką i czy w ogóle powinno się w ten sposób pracować ?

    pozdrawiam

    1. Wszystko zależy od organizacji. Sam Google pisze o tym w wielu miejscach jak chroni te informacje. Moim zdaniem jest to bezpieczne rozwiązanie dla wielu projektów. Z google docs korzysta mnóstwo dużo firm. Nie jest to jednak referencja do tego by korzystać z tego rozwiązania. Zawsze zanim użyję tego rozwiązania przeprowadzam analizę zagrożeń i korzyści dla tych dokumentów bo dane są poza zasobami danej firmy. Przykładowo w projekcie, w którym teraz uczestniczę mam 14 ekspertów merytorycznych. Tylko GDocs daje mi możliwość szybkiej analizy dokumentów. Ocena jest zawsze indywidualna.

Dodawanie komentarzy zostało zablokowane.

Scroll to Top