Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Strona tytułowa - zawiera logo, tytuł oraz podtytuł zawierający nazwę procesu oraz typ dokumentacji (biznesowa/techniczna)
  • Słownik pojęć
  • Link do systemu - występuje tylko, gdy niepusty
  • 1. Założenia i zakres wdrożenia
    • 1.1. Nazwa klienta
    • 1.2. Nazwa procesu
    • 1.3. Skład zespołu przeprowadzającego analizę procesu - dwa podpunkty (Po stronie firmy i Po stronie klienta), każdy z nich jako numerowana lista osób
    • 1.4. Skład zespołu wykonującego - dwa podpunkty (Po stronie firmy i Po stronie klienta), każdy z nich jako numerowana lista osób
    • 1.5. Ogólny opis procesu
    • 1.6. Sposób inicjacji procesu
    • 1.7. Opis powiadomień mailowych
    • 1.8. Szacowana liczba procesów na miesiąc
    • 1.9. Szacowana liczba osób biorących udział w procesie
  • 2. Wykaz klas dokumentów
  • 3. Wykaz zestawów dokumentów
  • 4. Wykaz ról procesu
    • 4.x. Użytkownik x
      • Opis uczestnika
  • 5. Mapa procesu i lista zadań - screen mapy procesu, numerowana lista zadań, pozycje na liście są linkami do opisów zadań w kolejnym rozdziale dokumentacji
  • 6. Wykaz pól procesu - każde z pól opisane w formie tabeli
    • 6.x. Pole x - kolumny w tabeli opisującej są następujące
      • Opis pola - występuje tylko, gdy opis jest niepusty
      • Informacja o występowaniu pola w tabeli
      • Typ pola
      • Podtyp pola - występuje tylko, gdy podtyp jest niepusty
      • Wymagalność
      • Tylko do odczytu
      • Wartość początkowa - występuje tylko, gdy wartość początkowa jest niepusta
      • Lista możliwych wartości - numerowana lista możliwych wartości pola, występuje tylko, gdy występują wartości
      • Parametry dynamicznej listy- występują tylko dla pola typu Dynamiczna lista
        • Typ
        • Nazwa klasy
        • Wymuś wybór wartości z listy
        • Aktualne wartości pól z formularza - numerowana lista pól lub wartości stałych, pozycje na liście dla pól są linkami do opisu pól, występuje tylko, gdy występują aktualne wartości
        • Autouzupełnianie wartości dla pól - numerowana lista pól, pozycje na liście są linkami do opisu pól, występuje tylko, gdy występuje autouzupełnianie
        • Dodatkowe parametry - numerowana lista postaci nazwa parametru: wartość parametru
  • 7. Szczegółowy opis zadań - podrozdziały są dodawane tylko dla zadań, przekierowań i podprocesów
    • 67.x. Zadanie x
      • Typ zadania
      • Ogólny opis zadania - występuje tylko, gdy opis jest niepusty
      • Wykonawca
      • Pola formularza - każde z pól opisane w formie tabeli z następującymi kolumnami, występuje tylko, gdy formularz posiada pola
        • Nazwa pola - w formie linku do opisu pola
        • Status - edytowalne, nieedytowalne, ukryte
      • Edytowalne pola formularza- listuje tylko edytowalne pola formularza, występuje tylko, gdy formularz posiada edytowalne pola
        • Opis pola - występuje tylko, gdy opis jest niepusty
        • Zdarzenie - występuje tylko, gdy pole posiada zdarzenie
          • Typ zdarzenia
          • Akcja
          • Źródła danych - numerowana lista pól, pozycje na liście są linkami do opisu pól
          • Pola wynikowe - numerowana lista pól, pozycje na liście są linkami do opisu pól
      • Tabele dynamiczne - występuje tylko, gdy formularz posiada tabele dynamiczne
        • Opis tabeli dynamicznej - występuje tylko, gdy opis jest niepusty
        • Kolumny - każda kolumna opisane w formie tabeli z następującymi kolumnami:
          • Nazwa pola - w formie linku do opisu pola
          • Status - edytowalne, nieedytowalne, ukryte
        • Przyciski - opis postaci: nazwa przycisku (akcja: nazwa akcji) - opis przycisku
      • Przyciski formularza Przycisk - występuje tylko, gdy formularz posiada przyciski formularzaprzycisk
        • Opis przycisku - występuje tylko, gdy opis jest niepusty
        • Akcja
        Przyciski akceptacji - występuje tylko, gdy formularz posiada przyciski akceptacji
        • Opis przycisku - występuje tylko, gdy opis jest niepusty
        • Sprawdzaj formularz
        • Ustawienie wartości pól- opisane w formie tabeli, która posiada następujące kolumny, występuje tylko, gdy przycisk ustawia wartości pól
          • Nazwa pola - w formie linku do opisu pola
          • Wartość
      • Generowane dokumenty - numerowana lista generowanych dokumentów, występuje tylko, gdy w zadaniu generowane są dokumenty
      • Automatyczne przejścia - numerowana lista zadań, pozycje na liście są linkami do opisów zadań, występuje tylko, gdy zadanie posiada automatyczne przejścia
      • Równoległa akceptacja
      • Akceptacja nowym dokumentem
      • Klasy dokumentów w podglądzie - numerowana lista klas dokumentów, pozycje na liście są linkami do opisów klas dokumentów w załączniku dokumentacji, występuje tylko, gdy zadanie posiada klasy dokumentów w podglądzie
      • Możliwe kolejne etapy - opisane w formie tabeli z następującymi kolumnami, występuje tylko, gdy zadanie posiada połączenie z innymi etapami lub zakończeniem procesu
        • Nazwa zadania - numerowana lista zadań, pozycje na liście są linkami do opisów zadań
        • Warunek przejścia
        • Opis przejścia
      • Opis powiadomień mailowych - występuje tylko, gdy opis jest niepusty
      • Formularz - screen formularza, występuje tylko, gdy zadanie posiada formularz
  • 78. Zadania automatyczne
    • 78.x. Zadanie automatyczne x
      • Ogólny opis zadania
      • Parametry wejściowe - numerowana lista parametrów
      • Parametry wyjściowe - numerowana lista parametrów
      • Generowane dokumenty - numerowana lista generowanych dokumentów, występuje tylko, gdy w zadaniu generowane są dokumenty
      • Wykonywana klasa/skrypt
      • Opis algorytmu
      • Możliwe kolejne etapy - opisane w formie tabeli z następującymi kolumnami, występuje tylko, gdy zadanie posiada połączenie z innymi etapami lub zakończeniem procesu
        • Nazwa zadania - numerowana lista zadań, pozycje na liście są linkami do opisów zadań
        • Warunek przejścia
        • Opis przejścia
  • 89. Tabele baz danych
    • 89.x. Tabela bazy danych x
      • Typ bazy danych
      • Lokalizacja
      • Wprowadzana przez menu administratora systemu
      • Kolumny - opisane w formie tabeli z następującymi kolumnami
        • Nazwa
        • Typ
        • Opis
      • Wykorzystanie w zadaniach - opisane w formie tabeli z następującymi kolumnami
        • Nazwa zadania - w formie linku do opisu zadania
        • Wykorzystanie
  • 910. Integracje z zewnętrznymi systemami
    • 910.x. Integracja x
      • Nazwa systemu
      • Cel wymiany danych
      • Metoda integracji
      • Opis integracji ze szczegółami technicznymi
  • 1011. Zadania programistyczne
    • 1011.x. Zadanie programistyczne
      • Opis zadania
      • Typ zadania
      • Miejsce wykonania
      • Parametry wejściowe - opisane w formie tabeli z następującymi kolumnami
        • Nazwa
        • Opis
      • Parametry wyjściowe - opisane w formie tabeli z następującymi kolumnami
        • Nazwa
        • Opis
      • Opis algorytmu
  • 1112. Zadania zaplanowane związane z procesem
    • 1112.x. Zadanie zaplanowane x
      • Opis zadania
      • Nazwa klasy
      • Nazwa metody
      • Parametry wejściowe - opisane w formie tabeli z następującymi kolumnami
        • Nazwa
        • Opis
      • Częstotliwość wykonania - postaci "wartość jednostka" np. 3 minuty
      • Opis algorytmu
  • Dodatek A - Mapa procesu
  • Dodatek B - Klasy dokumentów
    • x. Klasa dokumentów x
      • Położenie na dysku
      • Indeksy
        • Opis indeksu
        • Typ indeksu
      • Akcje
        • Źródło akcji
        • Typ akcji
        • Adres URL skryptu/Identyfikator definicji procesu - zależne od definicji akcji
  • Dodatek C - Zestawy dokumentów
    • x. Zestaw dokumentów x
      • Powiązania indeksów- opisane w formie tabeli o następujących kolumnach
        • Nazwa klasy dokumentów - w formie linku do opisu klasy dokumentów
        • Nazwa indeksu w zestawie
        • Nazwa indeksu w klasie
  • 13. Wyłączenia z projektu
    • 13.x. Wyłączenie z projektu
      • Treść