Documentatietemplates

Elk gegenereerd document volgt een documenttemplate. In de app heten ze Documentatietemplates. Een template bepaalt welke onderdelen in een document staan en in welke volgorde: de titelpagina, inhoudsopgave, hoofdstukken en secties, tekstblokken, documentatievelden, het model, de RACI-matrix, elementdocumentatie, grafieken en de RACI-toewijzing per activiteit.

Elk architectuurniveau heeft eigen templates. Zo kunnen een kort procesoverzicht, een gedetailleerde SOP en een auditpakket hetzelfde proces op verschillende manieren beschrijven.

Waar je templates vindt

• Instellingen → Process Architecture toont elk niveau als een kaart. Open de knop Documentatietemplates bij een niveau, of klik op het bewerkingspictogram om de editor te openen.
• Op het tabblad Documentatie kun je met de keuzelijst Documenttemplate in de zijbalk wisselen tussen documenten. De standaardtemplate van het niveau wordt gebruikt totdat iemand een andere kiest.
• Editors kunnen vanuit het document rechtstreeks naar de template gaan: open het exportmenu en kies Template bewerken….

Je stelt templates in bij Process Architecture. Iedereen die de documentatie van een proces kan lezen, ziet het document dat de template oplevert. Elke export gebruikt de template die op de documentatiepagina is geselecteerd.

Templates kiezen en beheren

De editor bestaat uit één venster: bovenaan staan de templatekeuzelijst en de knop om een template toe te voegen, links staat de documentstructuur en rechts de instellingen voor het geselecteerde onderdeel. Onderaan staan Annuleren en Opslaan.

De editor opent de template die je het laatst voor dat niveau hebt bewerkt. Met Template bewerken… op de documentatiepagina open je de template die voor het huidige document wordt gebruikt.

• Documenttemplate bovenaan wisselt tussen de templates van het niveau. Templates met de status Concept zijn niet zichtbaar voor kijkers. Standaard geeft aan welke template wordt gebruikt wanneer de documentatiepagina wordt geopend.
• + voegt een template toe met de naam Nieuwe documenttemplate en selecteert deze.
• Naam wijzigt de naam van de geselecteerde template.
• Gepubliceerd bepaalt of kijkers de template op de documentatiepagina kunnen selecteren. Editors zien concepten altijd.
• Als standaard instellen maakt de geselecteerde template de template die de documentatiepagina gebruikt als er geen andere is gekozen. Elk niveau heeft één standaardtemplate.
• Documenttemplate verwijderen verwijdert de geselecteerde template. Je kunt de enige standaardtemplate van een niveau niet verwijderen. Stel eerst een andere template als standaard in.
• Elementen zonder documentatie meenemen voegt modelelementen zonder beschrijving toe aan het elementengedeelte van het document. Schakel dit uit als het document alleen afgeronde documentatie mag bevatten.

Een template toevoegen of verwijderen en de standaardtemplate instellen gebeurt meteen. De naam, zichtbaarheid, instelling voor de opgenomen inhoud, titelpagina en documentstructuur worden opgeslagen met Opslaan.

Het document opbouwen

Links in de editor staat de documentstructuur. Sleep een onderdeel om het te verplaatsen, of zet het op een hoofdstuk of sectie om het daaronder te plaatsen. Gebruik het menu op de rij of klik met de rechtermuisknop op een rij om inhoud toe te voegen of te verwijderen.

Hoofdstukken en secties

• Hoofdstuk hieronder toevoegen voegt een hoofdstuk toe op het hoogste niveau van het document.
• Sectie toevoegen of Sectie hieronder toevoegen voegt een onderliggende of aangrenzende sectie toe.
• Selecteer een hoofdstuk of sectie om de Titel te bewerken en Automatisch nummeren aan of uit te zetten. De nummering volgt de structuur: hoofdstukken krijgen X, secties X.Y en diepere secties X.Y.Z. In het paneel zie je het kopniveau dat voor het onderdeel wordt gebruikt.
• Verwijderen verwijdert het geselecteerde onderdeel en de onderliggende onderdelen.

Inhoudsonderdelen

Het menu voor onderdelen bevat:

• Tekst toevoegen / Tekst hieronder toevoegen voegt een Markdown-blok toe. Schrijf koppen, lijsten, links of opmerkingen in het veld Markdown-tekst. Je kunt hier ook placeholders gebruiken.
• Documentatieveld toevoegen… / Documentatieveld hieronder toevoegen… voegt een gepubliceerd documentatieveld van het niveau toe. Wordt een veld later niet meer gepubliceerd, dan verdwijnt het uit het document. Zo bevat een document nooit informatie die het niveau niet meer publiceert.
• Model toevoegen / Model hieronder toevoegen geeft het procesdiagram weer. Met Data tonen voeg je onder het diagram de samenvatting ‘Gebruikte filters en data’ toe.
• RACI toevoegen / RACI hieronder toevoegen geeft de RACI-matrix weer.
• Elementen toevoegen / Elementen hieronder toevoegen geeft de documentatie van alle modelelementen weer.
• Sectie met grafieken toevoegen plaatst de grafiekdocumentatie op die plek in het document. Dit kan op het hoogste niveau of binnen een hoofdstuk of sectie.
• RACI per activiteit toevoegen voegt de RACI-toewijzing toe aan elke activiteit in het elementengedeelte. Op het hoogste niveau geldt dit voor het hele document.

Titelpagina toevoegen en Inhoudsopgave toevoegen zijn elk maar één keer beschikbaar op het hoogste niveau. Beide zijn onderdelen: selecteer er een om deze te bewerken, of verwijder deze als het document geen titelpagina of inhoudsopgave nodig heeft.

De titelpagina

Selecteer het onderdeel voor de titelpagina om het volgende in te stellen:

• Afbeelding uploaden, Vervangen of het verwijderpictogram voor de achtergrondafbeelding.
• Titel, standaard de procesnaam. Gebruik placeholders als de titel moet aansluiten op het proces.
• Ondertitel voor een versienummer, classificatie of doelgroep.

Placeholders

In bewerkbare tekst kun je placeholders gebruiken. ProcessMind vult deze in wanneer het document wordt weergegeven:

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

Klik op een placeholder om deze te kopiëren of dubbelklik erop om deze aan de bewerkte tekst toe te voegen. Heeft een placeholder geen waarde voor een proces, dan blijft deze leeg in het document.

Templates en exports

De template bepaalt de inhoud van het document. PDF, Word, Markdown en afdrukken volgen allemaal de geselecteerde template. Staat inhoud niet in de template, dan komt deze ook niet in de export. Verwijder een onderdeel om het in één template te verbergen. Wil je meerdere documentstijlen voor één procesniveau? Maak dan voor elke stijl een template en stel de template die de documentatiepagina moet openen in als standaard.

Gerelateerde onderwerpen

• De documentatie-editor
• Documentatie exporteren
• Process Architecture
• Architectuurniveaus