Case studies

Metoda Sp. z o.o. (projekt wewnętrzny)

Celem przedsięwzięcia był dobór oprogramowania naprawdę przydatnego dla wsparcia procesu realizacji zamówień. Przedsięwzięcie zostało uruchomione w związku z brakiem na rynku odpowiednich narzędzi informatycznych.

• Producenci systemów wspierających opisywanie i analizę procesów biznesowych oraz wymagań na systemy informatyczne koncentrują się na programach do modelowania graficznego, uzupełnianego o biurowe edytory tekstu, bez ich integracji lub z integracją ułomną (pozorną),

• Wizualizacja procesów i wymagań na systemy IT (przygotowanie modeli graficznych) ma ogromne znaczenie dla ich zrozumienia i rozwoju, jednak opracowanie takiej wizualizacji nie jest wystarczające, a jej utrzymanie wymaga dużo więcej czasu niż przygotowanie opisu w edytorze tekstu. Wizualizacja powinna być zatem wtórna w stosunku do opisu.

• Biurowe edytory tekstu oferują niewystarczające wsparcie dla współpracy wielu autorów, słabe możliwości rejestracji zmian oraz zerowe możliwości weryfikacji poprawności syntaktycznej opracowywanych specyfikacji.

• Przygotowanie dobrej specyfikacji wymaga podejścia iteracyjnego z rozproszoną dyskusją nad wynikami poszczególnych etapów realizacji zamówienia. Dyskusja e-mailowa się do tego nie nadaje.

• Na producentów oprogramowania komercyjnego ma się zazwyczaj niewielki wpływ jeśli chodzi o wprowadzanie nowych funkcji, rezygnację z funkcji zbędnych, które tylko komplikują dotarcie do rzeczy rzeczywiście przydatnych oraz szybką reakcję na zgłoszenia błędów w oprogramowaniu.

• Osoby z którymi firma współpracuje oraz jej klienci korzystają z różnych systemów operacyjnych.

W ramach przedsięwzięcia dokonano wyboru standardowego formatu dla plików wszelkich opracowań, jakim jest: DocBook XML. DocBook XML jest otwartym standardem o wieloletniej historii rozwoju, posiadającym wszelkie zalety XML (format tekstowy, modularny, łatwy do automatycznego przetwarzania i przeszukiwania, automatycznie weryfikowalny na okoliczność poprawności składniowej i strukturalnej), definiujący znaczniki umożliwiające tworzenie dokumentacji i możliwy do automatycznego przetwarzania na inne popularne formaty: HTML, PDF, RTF, ODT. Standard ten, bez zmiany jego definicji (tj. dodawania nowych znaczników) został przystosowany (przez odpowiednie wykorzystanie atrybutów znaczników) do opisu specyfikacji formalnej procesów biznesowych oraz przypadków użycia.

Mimo, że dokumenty DocBook XML mogą być edytowane z wykorzystaniem wielu edytorów XML, lub też edytorów tekstowych, dokonano wyboru narzędzia zalecanego: XMLmind XML Editor Standard Edition. Program ten pozwala pracować nad dokumentami DocBook XML w sposób zbliżony do komfortu pracy z popularnymi edytorami biurowymi (WYSIWYG), jest dostępny nieodpłatnie i działa na wielu systemach operacyjnych. Można powiedzieć, że edytor ten pozwala na pracę z bazą danych w sposób właściwy dla pracy nad dokumentami tekstowymi.

Wszelkie elementy składowe dokumentacji przechowywane są w repozytorium zarządzania wersjami i konfiguracją opartym na oprogramowaniu subversion, z dostępem zdalnym dla wszystkich autorów, poprzez standardowy, bezpieczny protokół sieciowy: https://.

Dokumentacja dostarczana jest adresatom w formie przetworzonej na publikacje WWW oraz, do wydruku, PDF/RTF. Publikacje te są generowane automatycznie dzięki zastosowaniu przystosowanych szablonów stylów DocBook XSL. Wykorzystanie oprogramowania dot pozwala na automatyczne generowanie diagramów przepływu w procesach i przypadkach użycia, wprost z ich opisu.

Publikacje WWW pozwalają na bieżące wyrażanie opinii na ich temat, jakie mogą być zamieszczane przez interesariuszy bezpośrednio na stronach prezentujących treści. Możliwość taką uzyskano dzięki zastosowaniu oprogramowania phpWebNotes.

Przykładami dokumentów przygotowanych z wykorzystaniem ww narzędzi są:

• Zarys Dokumentu: Ekspertyza — dokument z oferty Metoda Sp. z o.o.,

• Zarys Dokumentu: Wizja — dokument z oferty Metoda Sp. z o.o.,

• Zarys Dokumentu: Specyfikacja — dokument z oferty Metoda Sp. z o.o.,

• O systemie publikacji — dokument szczegółowiej informujący o wykorzystywanym przez Metoda Sp. z o.o oprogramowaniu,

• Zasady wykorzystania dokumentacji — dokument stanowiący pomoc dla użytkowników dokumentacji przygotowywanych przez Metoda Sp. z o.o.