Dokumentvorlagen

Jedes generierte Dokument basiert auf einer Dokumentvorlage. In der Anwendung heißen sie Dokumentvorlagen. Eine Vorlage legt fest, welche Bestandteile ein Dokument in welcher Reihenfolge enthält: Titelseite, Inhaltsverzeichnis, Kapitel und Abschnitte, Textblöcke, Dokumentationsfelder, Modell, RACI-Matrix, Elementdokumentation, Charts und RACI-Zuordnung für einzelne Aktivitäten.

Jede Architekturebene hat eigene Vorlagen. So können eine kurze Prozessübersicht, eine ausführliche SOP und ein Audit-Paket denselben Prozess unterschiedlich beschreiben.

Wo Sie Vorlagen finden

• Einstellungen → Prozessarchitektur zeigt jede Ebene als Karte. Öffnen Sie über die Schaltfläche Dokumentvorlagen oder das Bearbeitungssymbol den Editor der jeweiligen Ebene.
• Auf der Registerkarte Dokumentation können Sie mit der Auswahl Dokumentvorlage in der Seitenleiste zwischen den Dokumenten wechseln. Standardmäßig wird die für die Ebene festgelegte Vorlage verwendet, sofern niemand eine andere auswählt.
• Editoren können direkt aus dem Dokument zur Vorlage wechseln: Öffnen Sie das Exportmenü und wählen Sie Vorlage bearbeiten….

Vorlagen werden in der Prozessarchitektur konfiguriert. Alle Personen, die die Dokumentation eines Prozesses lesen können, sehen das Dokument, das die Vorlage erstellt. Jeder Export verwendet die Vorlage, die auf der Dokumentationsseite ausgewählt ist.

Vorlagen auswählen und verwalten

Der Editor besteht aus einem Dialog: Oben befinden sich die Vorlagenauswahl und die Schaltfläche zum Hinzufügen, links der Dokumentbaum und rechts die Einstellungen für den ausgewählten Knoten. In der Fußzeile finden Sie Abbrechen und Speichern.

Der Editor öffnet die Vorlage, die Sie zuletzt für diese Ebene bearbeitet haben. Über Vorlage bearbeiten… auf der Dokumentationsseite öffnen Sie die Vorlage, die für das aktuelle Dokument verwendet wird.

• **Mit der Auswahl **Dokumentvorlage oben wechseln Sie zwischen den Vorlagen der Ebene. Einträge mit der Kennzeichnung Entwurf sind für Benutzer mit Viewer-Zugriff nicht sichtbar. Standard kennzeichnet die Vorlage, die beim Öffnen der Dokumentationsseite verwendet wird.
• + fügt eine Vorlage mit dem Namen Neue Dokumentvorlage hinzu und wählt sie aus.
• Name benennt die ausgewählte Vorlage um.
• Veröffentlicht legt fest, ob Benutzer mit Viewer-Zugriff die Vorlage auf der Dokumentationsseite auswählen können. Editoren sehen auch Entwürfe.
• Als Standard festlegen bestimmt, welche Vorlage auf der Dokumentationsseite verwendet wird, wenn keine andere ausgewählt ist. Für jede Ebene gibt es eine Standardvorlage.
• Dokumentvorlage löschen entfernt die ausgewählte Vorlage. Die einzige Standardvorlage einer Ebene kann nicht gelöscht werden. Legen Sie zuerst eine andere Vorlage als Standard fest.
• Elemente ohne Dokumentation einbeziehen fügt Modellelemente ohne Beschreibung in den entsprechenden Dokumentabschnitt ein. Deaktivieren Sie die Option, wenn das Dokument nur abgeschlossene Dokumentation enthalten soll.

Eine Vorlage hinzufügen oder löschen sowie die Standardvorlage festlegen wird sofort übernommen. Name, Sichtbarkeit, die Option für einzuschließende Inhalte, die Titelseite und der Dokumentbaum werden mit Speichern gesichert.

Dokument aufbauen

Links im Editor befindet sich der Dokumentbaum. Ziehen Sie einen Knoten an eine andere Position, um ihn neu anzuordnen, oder legen Sie ihn auf einem Kapitel oder Abschnitt ab, um ihn unterzuordnen. Über das Menü in einer Zeile oder per Rechtsklick fügen Sie Inhalte hinzu oder entfernen sie.

Kapitel und Abschnitte

• Kapitel darunter hinzufügen fügt ein Kapitel auf der obersten Dokumentebene hinzu.
• Abschnitt hinzufügen oder Abschnitt darunter hinzufügen fügt einen untergeordneten oder gleichrangigen Abschnitt hinzu.
• Wählen Sie ein Kapitel oder einen Abschnitt aus, um den Titel zu bearbeiten und die Automatische Nummerierung ein- oder auszuschalten. Die Nummerierung richtet sich nach dem Baum: Kapitel erhalten Nummern wie X, ihre Abschnitte X.Y und tiefer verschachtelte Abschnitte X.Y.Z. Im Bereich sehen Sie die Überschriftenebene, die der Knoten erhält.
• Löschen entfernt den ausgewählten Knoten und seine untergeordneten Knoten.

Inhaltsknoten

Das Knotenmenü bietet folgende Optionen:

• Text hinzufügen / Text darunter hinzufügen fügt einen Markdown-Block hinzu. Schreiben Sie Überschriften, Listen, Links oder Hinweise in das Feld Markdown-Text. Auch hier können Sie Platzhalter verwenden.
• Dokumentationsfeld hinzufügen… / Dokumentationsfeld darunter hinzufügen… fügt ein veröffentlichtes Dokumentationsfeld der Ebene hinzu. Wird ein Feld später nicht mehr veröffentlicht, wird es aus dem Dokument entfernt. So enthält das Dokument keine Inhalte, die für die Ebene nicht mehr veröffentlicht werden.
• Modell hinzufügen / Modell darunter hinzufügen fügt das Prozessdiagramm ein. Mit Daten anzeigen wird unter dem Diagramm die Zusammenfassung „Verwendete Filter und Daten“ eingefügt.
• RACI hinzufügen / RACI darunter hinzufügen fügt die RACI-Matrix ein.
• Elemente hinzufügen / Elemente darunter hinzufügen fügt die Dokumentation aller Modellelemente ein.
• Chart-Abschnitt hinzufügen fügt die Chart-Dokumentation an dieser Stelle ein. Der Abschnitt kann auf der obersten Ebene oder in einem Kapitel beziehungsweise Abschnitt stehen.
• RACI für einzelne Aktivitäten hinzufügen fügt die RACI-Zuordnung für jede Aktivität im Elementabschnitt ein. Auf der obersten Ebene gilt sie für das gesamte Dokument.

Titelseite hinzufügen und Inhaltsverzeichnis hinzufügen stehen jeweils nur einmal und nur auf der obersten Ebene zur Verfügung. Beide sind Knoten: Wählen Sie einen aus, um ihn zu bearbeiten, oder löschen Sie ihn, wenn das Dokument keine Titelseite beziehungsweise kein Inhaltsverzeichnis enthalten soll.

Die Titelseite

Wählen Sie den Knoten für die Titelseite aus, um Folgendes festzulegen:

• Bild hochladen, Ersetzen oder das Symbol zum Entfernen des Hintergrundbilds.
• Titel, standardmäßig der Prozessname. Verwenden Sie Platzhalter, wenn sich der Titel nach dem Prozess richten soll.
• Untertitel für eine Versions-, Klassifizierungs- oder Zielgruppenangabe.

Platzhalter

Bearbeitbare Texte können Platzhalter enthalten, die ProcessMind beim Erstellen des Dokuments ausfüllt:

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

Klicken Sie auf einen Platzhalter-Chip, um ihn zu kopieren, oder doppelklicken Sie darauf, um ihn in den bearbeiteten Text einzufügen. Hat ein Platzhalter für einen Prozess keinen Wert, wird er als leerer Text ausgegeben.

Vorlagen und Exporte

Die Vorlage bestimmt den Inhalt des Dokuments. PDF, Word, Markdown und Druckausgaben folgen der ausgewählten Vorlage. Inhalte, die nicht in der Vorlage stehen, erscheinen auch nicht im Export. Um einen Abschnitt in einer Vorlage auszublenden, löschen Sie den zugehörigen Knoten. Wenn Sie für eine Prozessebene mehrere Dokumentstile benötigen, erstellen Sie für jeden Stil eine Vorlage und legen Sie fest, welche davon standardmäßig auf der Dokumentationsseite geöffnet wird.

Verwandte Themen

• Der Dokumentationseditor
• Dokumentation exportieren
• Prozessarchitektur
• Architekturebenen