Szablony dokumentacji

Każdy generowany dokument powstaje na podstawie szablonu dokumentu. W aplikacji szablony te noszą nazwę Szablony dokumentów. Szablon określa, jakie elementy znajdą się w dokumencie i w jakiej kolejności: stronę tytułową, spis treści, rozdziały i sekcje, bloki tekstu, pola dokumentacji, model, macierz RACI, dokumentację elementów, wykresy oraz przypisanie RACI dla poszczególnych aktywności.

Każdy poziom architektury ma własne szablony. Dzięki temu krótki przegląd procesu, szczegółowa procedura SOP i zestaw dokumentów audytowych mogą opisywać ten sam proces na różne sposoby.

Gdzie znaleźć szablony

• Ustawienia → Architektura procesów wyświetla każdy poziom w osobnej karcie. Otwórz przycisk Szablony dokumentów lub wybierz ikonę edycji, aby przejść do edytora.
• Na karcie Dokumentacja selektor Szablon dokumentu na pasku bocznym pozwala przełączyć się na inny szablon. Domyślnie używany jest szablon przypisany do danego poziomu, chyba że zostanie wybrany inny.
• Edytorzy mogą przejść bezpośrednio z dokumentu do jego szablonu: otwórz menu eksportu i wybierz Edytuj szablon….

Szablony konfiguruje się w sekcji Architektura procesów. Każda osoba, która może wyświetlać dokumentację procesu, widzi dokument wygenerowany na podstawie jego szablonu. Eksport korzysta z szablonu wybranego na stronie dokumentacji.

Wybieranie szablonów i zarządzanie nimi

Edytor to jedno okno dialogowe. U góry znajduje się selektor szablonów i przycisk dodawania, po lewej drzewo dokumentu, a po prawej ustawienia wybranego elementu. W stopce są przyciski Anuluj i Zapisz.

Edytor otwiera ostatnio edytowany szablon danego poziomu. Opcja Edytuj szablon… na stronie dokumentacji otwiera szablon używany przez bieżący dokument.

• Selektor Szablon dokumentu u góry pozwala przełączać się między szablonami danego poziomu. Pozycje oznaczone jako Wersja robocza są niewidoczne dla odbiorców, a oznaczenie Domyślny wskazuje szablon otwierany na stronie dokumentacji.
• + dodaje szablon o nazwie Nowy szablon dokumentu i wybiera go.
• Nazwa zmienia nazwę wybranego szablonu.
• Opublikowano określa, czy odbiorcy mogą wybrać szablon na stronie dokumentacji. Edytorzy zawsze widzą wersje robocze.
• Ustaw jako domyślne wskazuje wybrany szablon jako używany na stronie dokumentacji, gdy nie wybrano innego. Każdy poziom ma jeden szablon domyślny.
• Usuń szablon dokumentu usuwa wybrany szablon. Nie można usunąć jedynego domyślnego szablonu danego poziomu. Najpierw należy ustawić inny szablon jako domyślny.
• Uwzględnij elementy bez dokumentacji dodaje do dokumentu elementy modelu, które nie mają jeszcze opisu. Wyłącz tę opcję, jeśli dokument ma zawierać tylko ukończoną dokumentację.

Dodanie lub usunięcie szablonu oraz ustawienie domyślnego obowiązują od razu. Zmiany nazwy, widoczności, opcji uwzględniania treści, strony tytułowej i drzewa dokumentu zapisuje się przyciskiem Zapisz.

Budowanie dokumentu

Po lewej stronie edytora znajduje się drzewo dokumentu. Przeciągnij element, aby zmienić jego kolejność, albo upuść go na rozdziale lub sekcji, aby umieścić go niżej w strukturze. Menu wiersza lub kliknięcie wiersza prawym przyciskiem myszy pozwala dodawać i usuwać treści.

Rozdziały i sekcje

• Dodaj rozdział poniżej dodaje rozdział na głównym poziomie dokumentu.
• Dodaj sekcję lub Dodaj sekcję poniżej dodaje sekcję zagnieżdżoną albo równorzędną.
• Wybierz rozdział lub sekcję, aby edytować jego Tytuł i włączyć lub wyłączyć opcję Automatyczna numeracja. Numeracja odzwierciedla strukturę drzewa: rozdziały mają format X, ich sekcje X.Y, a kolejne poziomy X.Y.Z. Panel pokazuje poziom nagłówka używany dla danego elementu.
• Usuń usuwa wybrany element wraz z jego elementami podrzędnymi.

Elementy treści

Menu elementu zawiera następujące opcje:

• Dodaj tekst / Dodaj tekst poniżej dodaje blok Markdown. W polu Tekst Markdown można wpisać nagłówki, listy, linki i uwagi. Można też używać pól zastępczych.
• Dodaj pole dokumentacji… / Dodaj pole dokumentacji poniżej… dodaje jedno z opublikowanych pól dokumentacji danego poziomu. Jeśli pole zostanie później wycofane z publikacji, zniknie z dokumentu. Dzięki temu dokument nie wyświetla treści, których dany poziom już nie udostępnia.
• Dodaj model / Dodaj model poniżej wyświetla diagram procesu. Opcja Pokaż dane dodaje pod diagramem podsumowanie „Użyte filtry i dane”.
• Dodaj RACI / Dodaj RACI poniżej wyświetla macierz RACI.
• Dodaj elementy / Dodaj elementy poniżej wyświetla dokumentację wszystkich elementów modelu.
• Dodaj sekcję wykresów umieszcza dokumentację wykresów w wybranym miejscu dokumentu. Można ją dodać na głównym poziomie albo w dowolnym rozdziale lub sekcji.
• Dodaj RACI dla poszczególnych aktywności dodaje przypisanie RACI do każdej aktywności w sekcji elementów. Jeśli sekcja znajduje się na głównym poziomie, ustawienie obejmuje cały dokument.

Opcje Dodaj stronę tytułową i Dodaj spis treści są dostępne tylko na głównym poziomie, po jednym elemencie każdego rodzaju. Oba są elementami drzewa: wybierz jeden, aby go edytować, lub usuń go, jeśli dokument nie ma zawierać strony tytułowej albo spisu treści.

Strona tytułowa

Wybierz element strony tytułowej, aby ustawić:

• Prześlij obraz, Zastąp lub użyj ikony usuwania, aby zmienić obraz tła.
• Tytuł, którego domyślną wartością jest nazwa procesu. Użyj pól zastępczych, jeśli tytuł ma być dopasowany do procesu.
• Podtytuł, na przykład numer wersji, klasyfikacja lub informacja o odbiorcach.

Pola zastępcze

W edytowalnym tekście można używać pól zastępczych, które ProcessMind uzupełnia podczas generowania dokumentu:

{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}

Kliknij znacznik pola zastępczego, aby go skopiować, albo kliknij go dwukrotnie, aby dodać go do edytowanego tekstu. Jeśli proces nie ma wartości dla danego pola, w dokumencie pojawi się puste miejsce.

Szablony i eksport

Szablon określa zawartość dokumentu. Eksport do PDF, Word i Markdown oraz wydruk korzystają z wybranego szablonu. Treści, których w nim nie ma, nie pojawią się w eksporcie. Aby ukryć element w jednym szablonie, usuń go z drzewa. Jeśli dla jednego poziomu procesu potrzebnych jest kilka wersji dokumentu, utwórz osobny szablon dla każdej z nich i ustaw jako domyślny ten, który ma otwierać się na stronie dokumentacji.

Powiązane tematy

• Edytor dokumentacji
• Eksport dokumentacji
• Architektura procesów
• Poziomy architektury