Best Practices

Dieser Abschnitt enthält eine Sammlung von Tipps und Tricks, Konventionen und bekannten Hürden bei der Verwendung von primedocs für die Vorlagenerstellung.

Vorlagenhierarchie

• Verwenden Sie immer die dreistufige Hierarchie (Style, Layout, Inhalt) für Word-Vorlagen. Das Überspringen von Ebenen führt zu Mehraufwand bei Corporate-Identity-Änderungen.
• Platzieren Sie alle "kleinsten gemeinsamen Nenner"-Dokumentattribute (Logos, Kopf- und Fusszeilen, Seitenränder) in der Layoutvorlage, nicht in einzelnen Inhaltsvorlagen.
• Setzen Sie immer das Feld Basierend auf im Vorlageneditor, um eine Inhaltsvorlage mit einer Layoutvorlage und eine Layoutvorlage mit einer Stylevorlage zu verknüpfen.

Versionierung

• Erstellen Sie bei wesentlichen Vorlagenänderungen immer eine neue Version, anstatt die veröffentlichte Version direkt zu bearbeiten.
• Testen Sie Änderungen mit der Funktion "Dokument testen", bevor Sie sie veröffentlichen.
• Markieren Sie stabile Testversionen als "Entwurf", bevor Sie sie als "Veröffentlicht" kennzeichnen.

Berechtigungen

• Setzen Sie Berechtigungen durchdacht: Standard ist "Authentifizierte Benutzer", was allen Benutzern erlaubt, die Vorlage zu sehen und zu ändern. Schränken Sie bei Bedarf ein.
• Verwenden Sie Organisationseinheiten-Berechtigungen, um Vorlagen auf bestimmte Abteilungen zu beschränken.

Globale Konfigurationen und Übersetzungen

• Verwenden Sie Globale Konfigurationen für alle XML-Konfigurationen, die in mehreren Vorlagen wiederverwendet werden.
• Verwenden Sie Globale Übersetzungen für alle benutzersichtbaren Texte, die übersetzt werden müssen.
• Bevorzugen Sie typisierte globale Einträge gegenüber untypisierten (classic) Einträgen für bessere Validierung und Auffindbarkeit.

Tags

• Etablieren Sie eine einheitliche Tagging-Konvention in Ihrer Organisation.
• Verwenden Sie Tags, um zusammengehörige Vorlagen für einfaches Filtern und für primedocs Connect-Integrationen zu gruppieren.

Tipps & Tricks

• Shortcuts nutzen — z. B. das Formatvorlagen-Panel mit Strg + Alt + Umschalt + S öffnen.
• Vorlagen einfach halten — bauen Sie so einfach wie möglich. Einfache Vorlagen sind schneller erstellt, leichter zu pflegen und robuster.
• Kommentare im Code — dokumentieren Sie Code in Fields mit Kommentaren, damit er später nachvollziehbar bleibt.
• Möglichst Profilfelder verwenden — greifen Sie für Absender- und Organisationsangaben auf Profilfelder zurück, statt Werte fest in der Vorlage zu hinterlegen.
• Layouts vereinheitlichen — verwenden Sie möglichst wenige, gemeinsam genutzte Layout-Vorlagen, statt für jede Inhaltsvorlage ein eigenes Layout zu pflegen.
• Snippets nutzen — lagern Sie wiederkehrende Inhalte in Snippets aus, statt sie in jeder Vorlage zu duplizieren.
• Tabellen einfach halten — bei selbst definierten Tabellenformatvorlagen auf einfache Strukturen setzen.

Troubleshooting

Typische Fehlerquellen beim Layouten und ihre Ursachen:

Symptom	Mögliche Ursache	Lösung
Platzhalter wird nicht ersetzt	Feldname stimmt nicht mit der Platzhalterzuordnung überein	Feldnamen und Zuordnung prüfen (Gross-/Kleinschreibung, exakter Name)
Formatvorlage sieht anders aus als erwartet	Style-Verknüpfung fehlt oder wurde lokal überschrieben	Verknüpfung Basierend auf zur Style-Vorlage prüfen; lokale Formatierung zurücksetzen
Dropdown-Inhaltssteuerelement ist leer	Dropdown-/Schnellbaustein-Inhaltssteuerelemente sind an die jeweilige Vorlage gebunden	In Snippets keine Dropdown-/Schnellbaustein-Inhaltssteuerelemente verwenden (siehe Umsetzungsvarianten)

vorsicht

Änderungen in der Style-Vorlage wirken sich auf alle darauf aufbauenden Inhaltsvorlagen aus. Gehen Sie hier mit besonderer Vorsicht vor und testen Sie die Auswirkungen, bevor Sie eine geänderte Style-Vorlage freigeben.

warnung

Die Dokumentation für Best Practices für klassische Vorlagen befindet sich im Referenzbereich. Die obige Anleitung konzentriert sich auf moderne primedocs Vorlagen.