Niniejszy dokument zawiera przegląd dokumentacji rozwiązania Matrix42 Core . Zapoznanie się ze strukturą dokumentacji pozwala w pełni wykorzystać jej potencjał.

Niniejszy dokument obejmuje dokumentację rozwiązania Matrix42 Core . Dokumentacja sprzedażowa i inna dokumentacja nie są objęte zakresem niniejszego dokumentu.

Przegląd

Dokumentacja rozwiązania Matrix42 Core jest opublikowana w Efecte Docs . Składa się z czterech poziomów:

1. Wprowadzenie do rozwiązania
2. Przeglądy Pro
3. Opisy przypadków użycia
4. Instrukcje dotyczące dostawy.

Zadania dostawcze i przypadki testowe zawarte we wdrożeniach u nowych klientów (od IV kwartału 2023 r.) są powiązane z dokumentacją w docs.efecte.com , jak pokazano na poniższym rysunku.  

Typy i zawartość dokumentów

Wprowadzenie do rozwiązania

Wprowadzenie do rozwiązania zawiera ogólny przegląd rozwiązania. Opisuje rozwiązanie na wysokim poziomie, w tym jego kluczowe możliwości i cechy.

Wprowadzenie rozwiązania skierowane jest głównie do klientów.

Przeglądy Pro

Przeglądy procesów zawierają podsumowanie każdego procesu. Zawierają one:

• Krótkie podsumowanie
• Lista uwzględnionych przypadków użycia
• Diagram przypadku użycia
• Schemat blokowy Pro (jeśli dotyczy)
• Pro procesu (jeśli dotyczy)
• Terminologia
• Wymagania wstępne
• Wyniki
• Aktorzy i role
• Domyślna treść dostawy

Harmonogram Pro

Osie czasu Pro zapewniają wizualny przegląd procesu, od momentu jego rozpoczęcia do momentu zakończenia. Osie czasu opisują również niektóre wskaźniki wydajności procesu oparte na czasie, na przykład czas reakcji i rozwiązania w przypadku zarządzania incydentami.

Terminologia

W rozdziale poświęconym terminologii przedstawiono istotne pojęcia i ich krótkie definicje.

Wymagania wstępne

Definiuje wymagania wstępne procesu.

Wyniki

Definiuje wyniki i rezultaty procesu.

Aktorzy i role

Opisuje aktorów biorących udział w procesie i przypisuje aktorom role techniczne w narzędziu Efecte Service Management Tool (ESM).

Domyślna treść dostawy

Opisuje zakres domyślnej dostawy Matrix42 Core .

Opisy przypadków użycia

Opisy przypadków użycia opisują przypadki użycia należące do procesu. Nie pełnią one funkcji uid użytkownika aplikacji, ponieważ nie zawierają szczegółowych instrukcji dotyczących interakcji z interfejsem użytkownika. W kolejnych rozdziałach opisano zawartość dokumentów dotyczących przypadków użycia.

Przykładowy scenariusz

Przykładowy scenariusz przedstawia przykład z życia wzięty wraz z informacjami kontekstowymi, pozwalającymi opisać przypadek użycia w praktyczny sposób. Scenariusze przykładowe mają na celu pomóc czytelnikowi lepiej zrozumieć przypadek użycia.

Diagram przypadku użycia

Diagramy przypadków użycia zapewniają przegląd aktorów, aplikacji i działań (przypadki użycia w ramach głównego przypadku użycia). Diagramy przypadków użycia są udokumentowane zgodnie ze standardem UML . Diagramy przypadków użycia opisują działania i relacje, nie próbując opisywać procesu ani przepływu danych, jak ma to miejsce w przypadku schematu blokowego procesu.

Przepływ pracy

Rozdział poświęcony przepływom pracy opisuje jeden lub więcej przepływów pracy powiązanych z danym przypadkiem użycia. Można go postrzegać jako podproces procesu głównego. W praktyce przepływy pracy są opisywane jako ponumerowane listy kroków.

Wyniki

Rozdział „Wyniki” opisuje wyniki i rezultaty przypadku użycia. Na przykład, w wyniku przypadku użycia „Rozwiązywanie incydentów”, status zgłoszenia zmienia się na „Rozwiązany”, a problem został rozwiązany lub zaproponowano obejście.

Korzyści

Rozdział poświęcony korzyściom opisuje korzyści, jakie przypadek użycia ma zapewnić organizacji.

Instrukcje dostawy

W rozdziale poświęconym instrukcjom dostawy znajdują się linki do instrukcji dostawy istotnych dla danego przypadku użycia.

Docelowi odbiorcy dokumentów