Macro's

Binnen PDM draait alles om structuur, helderheid en herhaalbaarheid. Een handmatige documentatiemethodiek vraagt om een slimme motor die het zware werk achter de schermen overneemt. Deze motor wordt in PDM de PDM Engine genoemd.

De PDM Engine bestaat uit drie onafscheidelijke componenten:

De Bouwstenen: De inhoudelijke elementen en informatieobjecten van je documentatie.
De Relaties: De verbindingen en interacties tussen deze bouwstenen.
De Macro’s: De functionele vertalers die de bouwstenen en relaties omzetten naar een leesbare, visuele presentatie.

Wat doet een macro onder de motorkap?

Je kunt een macro het beste vergelijken met eeijn slimme snelkoppeling of een handmatige instructie aan de PDM Engine. In plaats van dat de Procesdocumentalist telkens ingewikkelde computercode hoeft te schrijven voor een specifiek visueel element (zoals een waarschuwingskader, een procesmatrix of een interactief diagram), kan gebruik gemaakt worden van korte, herkenbare tekstinstructies.

Achter de schermen gebeurt er op dat moment het volgende:

graph TD
    A([De schrijver]) -->|Typt eenvoudige macro-instructie| B[Ruwe Markdown tekst]
    B -->|Input voor de PDM Engine| Engine
    S(Sjablonen)
    subgraph Engine[PDM Engine]
        D[Herken macro-instructie]
        D --> E(Haalt onderliggend sjabloon op)
        E --> F(Vlecht Bouwstenen & Relaties in het sjabloon)
    end
    subgraph Website
    G[Projecties & Documentatie]
    end
    S --> E
    F -->|Output| G

Wanneer de website wordt gebouwd, scant de PDM Engine de documenten. Zodra de engine een macro-instructie tegenkomt, klapt deze als het ware uit. De engine pakt het bijbehorende, vooraf gedefinieerde sjabloon en vlecht de platte tekst en relaties naadloos samen tot de uiteindelijke, strak vormgegeven pagina.

Waarom macro’s?

Vanuit een functioneel perspectief bieden macro’s drie voordelen voor de betrouwbaarheid van de kennishub:

Consistentie in vormgeving
Elke procesbeschrijving, waarschuwing of diagram ziet er op de hele website exact hetzelfde uit. Omdat de vormgeving centraal in het macrosjabloon is vastgelegd, kan er nooit per ongeluk een afwijkend lettertype of een verkeerde kleurcode worden gebruikt. De structuur blijft altijd strak en professioneel.
Focus op de inhoud
De documentalist hoeft zich geen seconde bezig te houden met lay-out, uitlijning of webtechnologie. Je focust je puur op de inhoud van de bouwstenen en de logica van de relaties. De macro doet de rest. Dit verhoogt de snelheid en de kwaliteit van het documenteren aanzienlijk.
Centraal onderhoud
Mocht de visuele standaard van de methode in de toekomst veranderen , bijvoorbeeld omdat een kader een andere randkleur krijgt, dan hoeft die wijziging maar op één plek te worden doorgevoerd: in het macrosjabloon zelf. De PDM Engine past de nieuwe stijl direct toe op alle pagina’s waar die macro gebruikt wordt.

Macro’s in de praktijk

Binnen PDM kom je macro’s op verschillende plekken tegen. Denk hierbij aan:

Diagram-macro’s: Zoals de instructies die platte tekstlijnen transformeren naar de dynamische Mermaid.js-stroomdiagrammen die je op de Validatie-pagina ziet.
Informatie-kaders: Snelkoppelingen om opvallende tips, kritieke waarschuwingen of specifieke basisregels visueel te scheiden van de hoofdtekst.
Navigatie-elementen: Macro’s die ervoor zorgen dat knoppen en links naar onderliggende fasen altijd uniform en op de juiste plek worden weergegeven.

De macro is daarmee de onmisbare schakel die van losse documentatie-elementen één samenhangende, krachtige methode maakt.