Der vollständige Leitfaden für Referenzen im Texteditor

Einführung in Referenzen

In modernen Dokumentationssystemen ist es oft eine Herausforderung, Informationen über mehrere Dokumente hinweg aktuell und konsistent zu halten. Das Referenzsystem des Texteditors bietet hierfür eine elegante Lösung. Referenzen funktionieren wie intelligente Verknüpfungen, die Informationen aus anderen Bereichen des Systems – z. B. Produkte, SOPs, Formulare, Arbeitsanweisungen, Dokumente oder Vorlagen – direkt in dein aktuelles Dokument einfügen können.

Man kann sich Referenzen wie dynamische Lesezeichen vorstellen: Sie zeigen nicht nur auf eine bestimmte Stelle, sondern können Inhalte direkt anzeigen. Wenn sich die Quelldaten ändern, werden diese Referenzen automatisch aktualisiert – so bleibt dein Dokument stets auf dem neuesten Stand.

Referenztypen

Der Texteditor unterstützt zwei Haupttypen von Referenzen, die sich für unterschiedliche Anwendungsfälle eignen.

Abstrakte Referenzen

Abstrakte Referenzen werden durch Eingabe von / im Editor eingefügt. Sie bilden das Rückgrat flexibler und wiederverwendbarer Dokumente. Diese Referenzen sind kontextabhängig – ihr Inhalt richtet sich nach den gewählten Einstellungen und ist nicht fest mit einem bestimmten Datenobjekt verknüpft.

Beispiel: In einer Produktvorlage kannst du /Produkt/Name einfügen. Je nach Auswahl im „Abstract Reference Settings“-Menü wird dann automatisch der korrekte Produktname angezeigt. So kann dieselbe Vorlage für viele verschiedene Produkte verwendet werden, ohne dass das Dokument angepasst werden muss.

Abstrakte Referenzen sind immer dynamisch: Sie behalten die Verbindung zur Quelle und aktualisieren sich automatisch bei Änderungen. Dadurch sorgen sie für maximale Konsistenz und reduzieren den Pflegeaufwand erheblich.

Konkrete Referenzen

Konkrete Referenzen werden durch Eingabe von @ im Editor eingefügt und verweisen direkt auf ein bestimmtes Objekt im System. Es gibt zwei Varianten:

Dynamische konkrete Referenzen

Diese Referenzen verlinken dauerhaft auf ein bestimmtes Objekt. Änderungen an der Quelle werden automatisch übernommen. Dynamische Referenzen sind im Text farblich hervorgehoben (blau) und sorgen dafür, dass deine Dokumente immer auf dem aktuellen Stand bleiben.

Statische konkrete Referenzen

Bei statischen Referenzen wird der aktuelle Inhalt einmalig übernommen – ohne spätere Aktualisierung. Sie dienen dazu, den Stand eines Objekts zu einem bestimmten Zeitpunkt festzuhalten, z. B. für Audits oder Zertifizierungen.

Datentypen in Referenzen

Referenzen können unterschiedliche Datentypen enthalten, die jeweils passend dargestellt werden:

Klartext & Formatierter Text

Für einfache Inhalte wie Namen, IDs oder Versionen eignet sich Klartext. Rich-Text-Referenzen unterstützen Formatierungen wie Listen, Absätze und Hervorhebungen – ideal für Beschreibungen oder Prozessschritte.

Datumsreferenzen

Datumsfelder werden einheitlich formatiert angezeigt – hilfreich bei regulatorischen Anforderungen, wo Datumsformate standardisiert sein müssen.

Tabellarische Daten

Einige Informationen, wie z. B. Spezifikationslisten oder Risikomatrizen, werden als Tabellen dargestellt und behalten dabei ihre Struktur.

Tabellarische Verweise verfügen über leistungsstarke interaktive Funktionen, die es den Nutzern ermöglichen, Daten effektiv zu bearbeiten und zu analysieren:

• Sortieren: Klicke auf einen beliebigen Spaltenkopf, um die Tabelle nach dieser Spalte auf- oder absteigend zu sortieren. So kannst du Daten schnell nach bestimmten Kriterien ordnen.
• Spaltensichtbarkeit: Verwende die Sichtbarkeitsoption, um bestimmte Spalten ein- oder auszublenden. So kannst du dich auf die aktuell relevantesten Daten konzentrieren.
• Filter: Wende Filter auf beliebige Spalten an, um die Daten einzugrenzen. Das Filtersystem unterstützt Text-, Zahlen- und Datumsfilter.
• Spalten neu andordnen: Ziehe Spaltenköpfe per Drag-and-drop, um ihre Reihenfolge nach deinen Bedürfnissen anzupassen.
• Spaltenbreite anpassen: Ziehe die Ränder der Spaltenköpfe, um die Breite anzupassen und eine optimale Darstellung deiner Daten zu erreichen.

Nutzerreferenzen

Wenn du auf Personen im System verweisen willst (z. B. Dokumentverantwortliche oder Prüfer), kannst du Nutzerreferenzen verwenden. Diese zeigen den aktuellen Namen und ggf. weitere zugehörige Informationen an.

Wann welche Referenz verwenden?

Die Wahl der richtigen Referenzart hängt vom Anwendungsfall ab. Hier ein Überblick:

Abstrakte Referenzen – für wiederverwendbare Vorlagen

Wenn du eine Vorlage für verschiedene Produkte, Versionen oder Prozesse nutzen willst, sind abstrakte Referenzen ideal. Beispiel: Ein Medizintechnikunternehmen erstellt eine Standarddokumentation für unterschiedliche Modelle eines Sterilisators. Mit /Produkt/Name und anderen Platzhaltern wird automatisch der passende Inhalt eingefügt.

Vorteile:

• Reduziert Pflegeaufwand
• Höchste Konsistenz
• Ideal für wiederverwendbare Dokumente
• Minimiert das Risiko veralteter Informationen

Dynamische konkrete Referenzen – für stets aktuelle Informationen

Wenn du sicherstellen willst, dass z. B. Sicherheitsmaßnahmen oder Produktdaten immer auf dem neuesten Stand sind, nutze dynamische Referenzen. Änderungen an der Quelle werden automatisch übernommen.

Beispiel: Ein QMS-Dokument verweist auf aktuelle Spezifikationen eines Produkts – bei jeder Aktualisierung werden die neuen Werte automatisch angezeigt.

Statische konkrete Referenzen – für den Nachweis historischer Daten

Diese Referenzen bleiben unverändert – selbst wenn sich die Quelle später ändert. Sie eignen sich ideal für Audit-Trails oder zur Dokumentation des Stands bei einer bestimmten Freigabe.

Beispiel: Du willst dokumentieren, welche Risikoklassifizierung ein Produkt zum Zeitpunkt der MDR-Zertifizierung hatte. Mit einer statischen Referenz sicherst du diese Information zuverlässig.

Fazit

Das Referenzsystem im Texteditor ist ein mächtiges Werkzeug zur Erstellung dynamischer, konsistenter und wartungsarmer Dokumentation. Wenn du die verschiedenen Referenztypen gezielt einsetzt, kannst du:

• Wiederverwendung fördern
• Aktualität sicherstellen
• Historische Nachweise dokumentieren

Das spart Zeit, erhöht die Qualität und hilft dir, regulatorische Anforderungen mühelos zu erfüllen.