dokumentacja systemu

Nowoczesna forma prowadzenia dokumentacji systemu od eVolpe

W dzisiejszym wpisie przyglądamy się usprawnieniu proponowanemu klientom eVolpe w zakresie uporządkowania dokumentacji realizowanego projektu informatycznego.

SRS (z ang. Software Requirements Specification) to dokument zawierający wszystkie zidentyfikowane wymagania wobec powstającego oprogramowania. Stanowi odbicie planowanej architektury systemu i może być uzupełniany o informacje dotyczące sposobu zrealizowania rozpoznanych potrzeb.

W praktyce eVolpe zamiast skomplikowanego pliku tekstowego w wielu przypadkach funkcjonuje rozwiązanie oparte na popularnej Wikipedii. Intuicyjność takiej internetowej encyklopedii, dostępnej w każdej chwili po zalogowaniu na odpowiednie konto, sprawia, iż odnajdywanie informacji jest bardzo wygodne.

W eVolpe w celu utworzenia nowoczesnej platformy udostępniania dokumentacji korzystamy z tzw. MediaWiki. Jest to oprogramowanie  wykorzystywane przez wszystkie wersje językowe Wikipedii, szereg innych projektów Wikimedia Foundation, jak również inne, w pełni niezależnie działające serwisy. Oprogramowanie MediaWiki ma modułową strukturę i bez większych kłopotów może być modyfikowane i ulepszane przez rozszerzenia, które nadają mu nowe funkcje.

Dokumentacja systemu w formie Wiki a metodyka wdrożeniowa

SRS w formie Wiki sprawdza się zarówno we wdrożeniach realizowanych zgodnie z metodyką waterfall, jak i we frameworku Scrum. W obu przypadkach klienci eVolpe otrzymują dostęp do specyfikacji systemu. Odbywa się to jednak na różnych warunkach w zależności od wybranego przez nich trybu wdrożenia.

Podejście tradycyjne zakłada przekazanie dokumentacji w pliku tekstowym (koniecznie przed rozpoczęciem prac implementacyjnych). Zgodnie z założeniami metodyki waterfall „kartoteka” systemu stanowi formalną podstawę do rozpoczęcia prac nad wdrożeniem oraz specyfikację zatwierdzonego obustronnie rozwiązania. To z zawartych w niej zapisów wywiązuje się firma wdrożeniowa. W przypadku podejścia zwinnego wymagania wobec produktu zmieniają się na bieżąco, na podstawie aktualnych potrzeb użytkowników, a ich postać jest o wiele mniej formalna (User Stories).

Wychodząc naprzeciw oczekiwaniom naszych klientów, którzy także w przypadku prac w SCRUM-ie chcieliby otrzymać przejrzystą dokumentację zamówionego systemu, proponujemy rozwiązanie SRS Wiki! Dodatkowo dobrą praktyką eVolpe jest przekazywanie przyrostu dokumentacji wraz z przyrostem oprogramowania na koniec każdej z iteracji.

Dokumentacja systemu a User Experience

Wymagania wobec systemu wraz z informacją o ich zrealizowaniu trafiają do Wiki częściowo automatycznie. Stosowana w eVolpe technologia pozwala na uzupełnienie części informacji bez udziału programistów i analityków. Nasz zespół utworzył odpowiednie skrypty automatyzujące generowanie dokumentacji projektu. Oznacza to, iż struktura informacyjna może być uzupełniana szybko i bez poświęcania na to dodatkowych mocy przerobowych zespołu.

Wyłącznie opisy użyteczności, zaawansowanej walidacji czy zadań spełnianych przez poszczególne mechanizmy wymagają dodatkowego doprecyzowania i ręcznego wprowadzenia informacji.

Odnajdywanie informacji przy pomocy Wiki SRS jest niezwykle wygodne i do złudzenia przypomina poruszanie się po Wikipedia.org. Interesujące nas wątki możemy przeszukiwać po kategoriach, korzystając z wewnętrznych linków, a także wpisując zapytania w wyszukiwarkę.

Struktura poszczególnych modułów oraz obsługujące je mechanizmy przedstawiane są w formie prostej do odczytania tabeli. Jak wskazano powyżej, takie zestawienie uzupełniane jest automatycznie, gdyż polega wyłącznie na wprowadzaniu wartości „TAK” lub „NIE” dla właściwych pól. W ten sposób można łatwo rozpoznać, czy system posiada konkretne funkcje w obrębie interesującego nas obszaru. 

Jak widać na powyższej ilustracji, oprócz tabeli strukturalnej, SRS w formie Wiki zawiera także opis biznesowego przeznaczenia wskazanego modułu oraz screen miejsca w systemie, o którym mowa.  Wszystko to sprzyja wygodzie korzystania z dokumentacji oprogramowania, która w tradycyjnej formie bywa zawiła i dość skomplikowana w odbiorze.

Przy pomocy SRS Wiki można również objaśnić obsługiwane przez system procesy, akcje, integracje itp. Oprócz słownego opisu ich przebiegu proponowana przez eVolpe dokumentacja projektu wdrożeniowego umożliwia umieszczanie zdjęć, diagramów i zrzutów ekranu, które obrazują interesujące nas kwestie.

Oferowane przez eVolpe rozwiązanie prowadzenia dokumentacji oprogramowania w formie internetowej encyklopedii sprzyja uporządkowaniu oraz przejrzystości informacji w niej zawartych. Co zrozumiałe, plik tekstowy jest o wiele trudniejszy w odbiorze. Posiadając doświadczenie korzystania z Wikipedii, wręcz intuicyjnie odszukujemy interesujące nas pojęcia zapisane w SRS Wiki. Do tej webowej platformy możemy zalogować się, przebywając w dowolnym miejscu na świecie (jeżeli tylko posiadamy dostęp do Internetu). Jest to zatem o wiele bardziej wygodne rozwiązanie niż taka tradycyjna, „analogowa” forma prowadzenia dokumentacji. Dzięki SRS Wiki uproszczone jest również dokonywanie zmian, aktualizowanie wiedzy o wdrażanym — zwłaszcza zwinnie — oprogramowaniu.

Część takich modyfikacji odbywa się wręcz automatycznie!

Umów konsultację z ekspertem wdrożeniowym eVolpe

Potrzebujesz doradztwa w sprawie oprogramowania dla biznesu? Chcesz wiedzieć, kiedy dokładnie zadzwoni telefon? Zobacz jak możemy Ci pomóc.

Przewiń do góry