Šablony dokumentace

Každý vytvořený dokument vychází z šablony dokumentu. V aplikaci se jim říká Šablony dokumentace. Šablona určuje, které části dokument obsahuje a v jakém pořadí: titulní stranu, obsah, kapitoly a oddíly, textové bloky, pole dokumentace, model, matici RACI, dokumentaci prvků, grafy a přiřazení RACI k jednotlivým aktivitám.

Každá úroveň architektury má vlastní šablony. Stručný přehled procesu, podrobný standardní operační postup i podklady pro audit tak mohou popisovat stejný proces různými způsoby.

Kde najdete šablony

• Nastavení → Architektura procesů zobrazuje každou úroveň jako kartu. Otevřete editor kliknutím na štítek Šablony dokumentace nebo na ikonu úprav u dané úrovně.
• Na kartě Dokumentace můžete v postranním panelu pomocí výběru Šablona dokumentu přepnout na jiný dokument. Dokud nevyberete jinou šablonu, použije se výchozí šablona dané úrovně.
• Editoři mohou přejít z dokumentu přímo k jeho šabloně: otevřete nabídku exportu a zvolte Upravit šablonu….

Šablony se nastavují v části Architektura procesů. Každý, kdo může číst dokumentaci procesu, uvidí dokument vytvořený podle jeho šablony. Při každém exportu se použije šablona vybraná na stránce dokumentace.

Výběr a správa šablon

Editor se otevírá v jednom dialogovém okně. Nahoře najdete výběr šablony a tlačítko pro přidání, vlevo strom dokumentu a vpravo nastavení vybrané položky. V dolní části jsou tlačítka Zrušit a Uložit.

Editor se otevře se šablonou, kterou jste pro danou úroveň upravovali naposledy. Možnost Upravit šablonu… na stránce dokumentace otevře šablonu právě používanou pro daný dokument.

• Výběr Šablona dokumentu nahoře slouží k přepínání mezi šablonami dané úrovně. Položky označené jako Koncept nejsou uživatelům portálu viditelné. Označení Výchozí určuje šablonu, která se otevře na stránce dokumentace.
• + přidá šablonu s názvem Nová šablona dokumentu a vybere ji.
• Název změní název vybrané šablony.
• Publikováno určuje, zda si uživatelé portálu mohou šablonu vybrat na stránce dokumentace. Editoři vidí i koncepty.
• Nastavit jako výchozí nastaví vybranou šablonu jako tu, která se použije na stránce dokumentace, pokud nevyberete jinou. Každá úroveň má jednu výchozí šablonu.
• Smazat šablonu dokumentu odstraní vybranou šablonu. Jedinou výchozí šablonu úrovně nelze smazat. Nejdřív nastavte jako výchozí jinou šablonu.
• Zahrnout prvky bez dokumentace přidá do části dokumentu věnované prvkům modelu také prvky, které zatím nemají popis. Pokud má dokument obsahovat jen dokončenou dokumentaci, tuto možnost vypněte.

Přidání a odstranění šablony i nastavení výchozí šablony se projeví okamžitě. Název, viditelnost, přepínač zahrnutí obsahu, titulní stranu a strom dokumentu uložíte tlačítkem Uložit.

Sestavení dokumentu

Na levé straně editoru je strom dokumentu. Přetažením položky změníte její pořadí nebo ji vložíte do kapitoly či oddílu. Obsah přidáte nebo odstraníte pomocí nabídky u řádku nebo kliknutím pravým tlačítkem na řádek.

Kapitoly a oddíly

• Přidat kapitolu níže přidá kapitolu do kořenové úrovně dokumentu.
• Přidat oddíl nebo Přidat oddíl níže přidá vnořený oddíl nebo oddíl na stejné úrovni.
• Vyberte kapitolu nebo oddíl a upravte jeho Název. Přepínačem Automatické číslování číslování zapnete nebo vypnete. Číslování odpovídá struktuře stromu: kapitoly mají tvar X, jejich oddíly X.Y a další úrovně X.Y.Z. Panel zobrazuje úroveň nadpisu, kterou položka vytvoří.
• Smazat odstraní vybranou položku i její podřízené položky.

Obsahové položky

Nabídka položek obsahuje tyto možnosti:

• Přidat text / Přidat text níže vloží blok Markdown. Do pole Text Markdown můžete napsat nadpisy, seznamy, odkazy nebo poznámky. Lze použít i zástupné symboly.
• Přidat pole dokumentace… / Přidat pole dokumentace níže… vloží jedno z publikovaných polí dokumentace dané úrovně. Pokud pole později přestanete publikovat, z dokumentu se odstraní. Dokument tak nikdy nezobrazí obsah, který už daná úroveň nezveřejňuje.
• Přidat model / Přidat model níže vloží diagram procesu. Možnost Zobrazit data přidá pod diagram souhrn „Použité filtry a data“.
• Přidat RACI / Přidat RACI níže vloží matici RACI.
• Přidat prvky / Přidat prvky níže vloží dokumentaci všech prvků modelu.
• Přidat oddíl s grafy vloží dokumentaci grafů na vybrané místo v dokumentu. Lze ho přidat do kořenové úrovně, kapitoly i oddílu.
• Přidat RACI jednotlivých aktivit přidá přiřazení RACI ke každé aktivitě v části věnované prvkům. Pokud položku přidáte do kořenové úrovně, použije se pro celý dokument.

Přidat titulní stranu a Přidat obsah lze pouze do kořenové úrovně, vždy jednou. Obě možnosti vloží položku do stromu. Vyberte ji a upravte, případně ji smažte, pokud dokument nemá mít titulní stranu nebo obsah.

Titulní strana

Vyberte položku titulní strany a nastavte:

• Nahrát obrázek, Nahradit nebo ikonu odebrání obrázku na pozadí.
• Název, který se ve výchozím nastavení převezme z názvu procesu. Pokud se má měnit podle procesu, použijte zástupné symboly.
• Podtitul pro verzi, klasifikaci nebo cílovou skupinu.

Zástupné symboly

V upravitelném textu můžete použít zástupné symboly, které ProcessMind při vytváření dokumentu doplní:

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

Kliknutím na zástupný symbol ho zkopírujete, dvojklikem ho vložíte do upravovaného textu. Pokud pro daný proces nemá zástupný symbol žádnou hodnotu, zobrazí se jako prázdný text.

Šablony a exporty

Šablona určuje podobu dokumentu. Export do PDF, Wordu, Markdownu i tisk vychází z vybrané šablony. Obsah, který v ní není, se do exportu nedostane. Pokud chcete v jedné šabloně část skrýt, smažte její položku. Pro různé podoby dokumentů na jedné úrovni procesu vytvořte samostatnou šablonu pro každou z nich a jako výchozí nastavte tu, která se má otevřít na stránce dokumentace.

Související témata

• Editor dokumentace
• Export dokumentace
• Architektura procesů
• Úrovně architektury