Documentation Templates

Every generated document follows a document template. The app calls them Document templates. A template decides which parts a document contains and in what order: the title page, the table of contents, chapters and sections, text blocks, documentation fields, the model, the RACI matrix, element documentation, charts, and the per-activity RACI assignment.

Each architecture level owns its own templates, so a short process overview, a detailed SOP, and an audit pack can all describe the same process in different ways.

Where Templates Live

• Settings → Process Architecture shows each level as a card. Open the level’s Document templates pill, or its edit icon, to open the editor.
• On the Documentation tab, the sidebar’s Document template selector switches the document you are reading. The level’s default template is used until someone picks another template.
• Editors can jump from the document straight to its template: open the export menu and choose Edit template….

Templates are configured in Process Architecture. Anyone who can read a process’s documentation sees the document its template produces, and every export uses the template that is selected on the documentation page.

Choose and Manage Templates

The editor is one dialog: the template selector and add button at the top, the document tree on the left, and the settings for the selected node on the right. The footer holds Cancel and Save.

The editor opens on the template you last edited for that level. Edit template… on the documentation page opens the template the current document is using.

• Document template select at the top switches between the level’s templates. Entries marked Draft are not visible to viewers; Default marks the template the documentation page opens with.
• + adds a template named New document template and selects it.
• Name renames the selected template.
• Published controls whether viewers can select the template on the documentation page. Editors always see drafts.
• Set as Default makes the selected template the one the documentation page uses when no other template is chosen. Each level has one default.
• Delete document template removes the selected template. You cannot delete a level’s only default template; set another template as default first.
• Include elements without documentation adds model elements that have no description yet to the elements part of the document. Turn it off when a document should only list finished documentation.

Adding a template, deleting a template, and setting the default apply immediately. Name, visibility, the included-content switch, the title page, and the document tree are saved with Save.

Build the Document

The left side of the editor is the document tree. Drag a node to reorder it, or drop it on a chapter or section to nest it. Use the row menu button, or right-click a row, to add and remove content.

Chapters and Sections

• Add chapter below adds a chapter at the document root.
• Add section or Add section below adds a nested or sibling section.
• Select a chapter or section to edit its Title and switch Auto-number on or off. Numbering follows the tree: chapters are X, their sections X.Y, and deeper sections X.Y.Z. The panel shows the heading level the node renders.
• Delete removes the selected node and its children.

Content Nodes

The node menu offers:

• Add text / Add text below adds a Markdown block. Write headings, lists, links, or notes in the Markdown text field. Placeholders work here too.
• Add doc field… / Add doc field below… adds one of the level’s published documentation fields. A field that is later unpublished is dropped from the document, so a document never shows content the level no longer publishes.
• Add model / Add model below renders the process diagram. Show data adds the “Filter & Data used” summary below the diagram.
• Add RACI / Add RACI below renders the RACI matrix.
• Add elements / Add elements below renders the documentation of every model element.
• Add charts section places the chart documentation at that position in the document. It works at the root or inside any chapter or section.
• Add individual activity RACI adds the RACI assignment to each activity in the elements section. At the root it applies to the whole document.

Add title page and Add table of contents are only offered at the root, once each. Both are nodes: select one to edit it, or delete it when a document should not have a title page or table of contents.

The Title Page

Select the title page node to set:

• Upload image, Replace, or the remove icon for the background image.
• Title, which defaults to the process name. Use placeholders when the title should follow the process.
• Subtitle for a version, classification, or audience line.

Placeholders

Editable text supports placeholders that ProcessMind fills in when it renders the document:

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

Click a placeholder chip to copy it, or double-click it to add it to the edited text. A placeholder that has no value for a process renders as empty text.

Templates and Exports

The template is the document. PDF, Word, Markdown, and print all follow the selected template, and content that is not in the template is not in the export. To hide a part for one template, delete its node. To keep several document styles for one process level, create one template per style and set the one the documentation page should open with as the default.

Related topics

• The Documentation Editor
• Exporting Documentation
• Process Architecture
• Architecture Levels