Variablen sind wiederverwendbare Textelemente, mit denen man einen Wert einmal definieren und ihn über mehrere Artikel und Kategorieseiten hinweg einfügen kann. Wenn sich der Wert ändert, aktualisiert man die Variable an einer Stelle und jeder Artikel, der ihn verwendet, aktualisiert sich automatisch.
Wenn zum Beispiel deine Support-E-Mail in 40 Artikeln und Änderungen erscheint, aktualisiert das Aktualisieren der Variablen einmal sofort alle 40 Artikel.
Wann Variablen verwendet werden sollten
Verwenden Sie Variablen für kurze, textbasierte Inhalte, die:
- Erscheint in mehreren Artikeln oder Kategorienseiten.
- Es wird sich wahrscheinlich im Laufe der Zeit ändern, wie zum Beispiel Kontaktdaten, Versionsnummern, Produktnamen, URLs, Feldbeschriftungen oder Haftungsausschlüsse.
- Es muss über die gesamte Wissensdatenbank hinweg konsistent bleiben.
Für längere oder formatierte Inhalte wie Absätze, Tabellen, Aufrufe oder Bilder verwenden Sie stattdessen Snippets .
Variablen vs. Ausschnitte
| Variablen | Ausschnitte | |
|---|---|---|
| Inhaltstyp | Klartext, Zahlen, Links, kurze Phrasen. | Formatierte Blöcke wie Absätze, Tabellen, Bilder, Aufrufe und Code. |
| Typische Verwendung | Produktnamen, Versionsnummern, Support-E-Mails. | Haftungsausschlüsse, gemeinsame Schritte, Kontaktsperren, wiederholte Warnungen. |
| Zeichenbegrenzung | 300 Zeichen. | Kein Zeichenlimit. |
| Formatierungsunterstützung | Nur grundlegende Inline-Formatierung. | Vollständiges Editor-Format. |
| Eingefügt über | Toolbar, Code-Syntax oder Schrägstrich-Befehl. | Syntax von Werkzeugleiste oder Merge-Code. |
Fang mit Variablen an
Variablen erstellen und verwalten
Erstelle eine Variable und konfiguriere ihren Namen, Merge-Code, Sprache und Inhalt. Bearbeiten, löschen, massenhaftes Löschen und Artikelabhängigkeiten anzeigen.
Erfahren Sie mehr →Verwendung und Übersetzung von Variablen
Füge Variablen in Artikel mit der Symbolleiste, der Merge-Code-Syntax oder dem Schrägstrichbefehl ein. Übersetze Variablen für mehrsprachige Wissensdatenbanken.
Erfahren Sie mehr →Best Practices
- Verwende Variablen für Inhalte, die sich ändern, nicht Inhalte, die fest bleiben. Variablen sind am wertvollsten, wenn der Inhalt regelmäßig aktualisiert werden muss. Wenn sich ein Wert wahrscheinlich nicht ändert, ist es einfacher und leichter zu überprüfen, ihn inline zu schreiben.
- Verwenden Sie nur Variablen, wenn derselbe Inhalt an drei oder mehr Orten erscheint. Wenn etwas nur in ein oder zwei Artikeln erscheint, geht es schneller, diese direkt zu aktualisieren, als eine Variable zu erstellen und zu verwalten.
- Verwenden Sie beschreibende, spezifische Namen. Nennen Sie Variablen, damit die Mitwirkenden auf einen Blick die richtige identifizieren können. Zum Beispiel
SupportEmailist oderProductVersion_iOSklarer alsemail1oderv1. Unklare Namen verlangsamen das Authoring und führen dazu, dass die falsche Variable eingefügt wird. - Setze den Sprachumfang bewusst. Verwenden Sie Global für Werte, die in jeder Sprache gleich sind, wie zum Beispiel einen Produktnamen, der nie übersetzt wird. Verwenden Sie sprachspezifische Variablen für Werte, die je nach Standort variieren, wie eine regionale Telefonnummer oder eine lokalisierte URL.
- Überprüfen Sie die Spalte "Verwendet" vor dem Bearbeiten oder Löschen. Eine Bearbeitung einer Variablen aktualisiert sofort jeden Artikel, der sie verwendet, einschließlich veröffentlichter. Bevor Sie eine Änderung vornehmen, überprüfen Sie, welche Artikel betroffen sind, damit Sie überprüfen können, ob der aktualisierte Wert in allen Kontexten korrekt gelesen wird.
- Verwende keine Variablen in Schnipseln. Variablen in Ausschnitten werden in der Editor-Vorschau oder in PDF-Exporten nicht korrekt dargestellt. Wenn ein Snippet dynamische Werte benötigt, verwalte sie separat.