Pläne, die diese Funktion unterstützen: Professional Business Enterprise
Man kann Variablen wiederverwenden, wenn man denselben textbasierten Inhalt an mehreren Orten verwendet, die sich im Laufe der Zeit ändern können (wie Feldnamen, Kontaktnummern, Adressen, Haftungsausschlüsse usw.). Eine Variable in Document360 ist ein wiederverwendbares Element, das hilft, Konsistenz und Effizienz in verschiedenen Dokumentationsabschnitten zu gewährleisten. Durch den Einsatz von Variablen können Beitragende Ihrer Artikel Informationen einfach an einem Ort aktualisieren, was sich automatisch in der gesamten Dokumentation widerspiegelt, was die Genauigkeit gewährleistet und redundante Aufwand reduziert.
Zum Beispiel möchten Sie Ihre Kontaktdaten in mehreren Fällen hinzufügen, die sich im Laufe der Zeit ändern können. In diesem Fall können Sie eine Variable für Kontaktinformationen hinzufügen. Wenn eine Änderung erforderlich ist, kannst du die Variable allein aktualisieren, anstatt sie in allen Fällen zu aktualisieren.
Variablen-Seite
Du kannst Variables anzeigen, bearbeiten oder löschen.
Um auf die Variables zuzugreifen:
Navigiere zu Content tools (
) in der linken Navigationsleiste im Knowledge base portal.Im linken Navigationsfenster navigieren Sie zu Content resources > Variables.
Die Variables erscheint, auf der Sie die Liste der bereits hinzugefügten Variables finden können.
Die Variables öffnet sich und zeigt die Liste der vorhandenen Variablen (falls vorhanden).
Anleitung: Klicken Sie, um ein Tutorial zur Verwendung von Variablen zu sehen.
Dokumentation: Klicken Sie hier, um den Dokumentationsartikel über Variablen zu öffnen.
Erstellen: Klicken Sie, um eine neue Variable zu erstellen.
Sprachen: Filtern Sie die Variablen nach Global oder einer bestimmten Sprache.
Suchvariable: Verwenden Sie diese, um eine Variable nach Namen zu suchen.
Variable auswählen: Verwenden Sie das Kontrollkästchen, um eine oder mehrere Variablen auszuwählen, um eine Massenlöschoperation durchzuführen. Klicken Sie auf den Variablennamen, um den Inhalt anzusehen.
Verwendung in:
Wenn in keinem Artikel oder einer Kategorieseite eine Variable verwendet wird, erscheint ein Bindestrich (-).
Wenn es verwendet wird, klicken Sie auf Ansicht, um eine Liste von Artikeln oder Kategorien zu sehen, in denen es erscheint.
Sprache: Zeigt die Sprache für jede Variable an.
Zuletzt geändert: Zeigt das Datum und die Uhrzeit der letzten Aktualisierung der Variable an.
Übersetzung: Klicken Sie auf das Globe-Symbol, um den Übersetzungsfortschritt der Variablen zu sehen. Klicken Sie auf das Globussymbol () neben jeder Variablen. A zeigt an, dass die Variable in diese Sprache übersetzt wurde, während das Symbol anzeigt, dass sie noch nicht übersetzt wurde.
Bearbeiten (): Klicken Sie, um den variablen Inhalt zu bearbeiten. Nach dem Bearbeiten klicken Sie auf Aktualisieren.
Löschen (): Klicken Sie, um eine Variable zu löschen. Um mehrere Variablen in einer Instanz zu löschen, wählen Sie das gewünschte Kontrollkästchen aus und klicken Sie oben auf Löschen .
Erstellen Sie eine Variable
Um eine Variable zu erstellen:
Navigiere zu Content tools (
) in der linken Navigationsleiste im Knowledge base portal.Im linken Navigationsfenster navigieren Sie zu Content resources > Variables.
Auf der Seite Variablen klicken Sie oben rechts auf Erstellen .
Geben Sie den Namen der Variablen ein.
HINWEIS
Variablennamen können Buchstaben, Zahlen, Bindestriche und Unterstriche enthalten. Der Name darf 50 Zeichen nicht überschreiten.
Der Merge-Code-Wert ist der Variablenname, der zusammen mit dem Variablen-Tag in deinem Editor erscheint.
Zum Beispiel, wenn dein Variablenname ist
Disclaimer, ist der Merge-Code{{variable.Disclaimer}}.Aus dem Sprach-Dropdown :
Standardmäßig ist die Auswahl Global (gilt für alle Sprachen).
Man kann auch eine bestimmte Sprache auswählen, um eine sprachspezifische Variable zu erstellen.
Im Content-Feld geben Sie die variable Content ein.
HINWEIS
Das variable Inhaltslimit beträgt 300 Zeichen, einschließlich Leerzeichen. Für längere Texte oder Medien verwenden Sie Snippets.
Formatierungsoptionen
Sie können Ihre variablen Inhalte mit den folgenden Formatierungswerkzeugen stylen:
Schriftfamilie (): Änderung der Schriftfamilie des Textes.
Schriftgröße: Passen Sie die Textgröße zwischen 8 und 48 an.
Fett () Wichtige Wörter oder Phrasen betonen.
Kursiv (): Text markieren oder Begriffe wie Variablen oder Titel markieren.
Unterstreichen (): Füge eine Zeile unter den Text zur Betonung hinzu.
Textfarbe: Ändern Sie die Farbe des Textes mit einem Farbwähler oder HEX-Code.
Hintergrundfarbe: Ändere die Hintergrundfarbe hinter dem Text.
Klicken Sie auf das Menü Mehr (), um weitere Optionen zu erhalten:
Inline-Code (): Formatieren Sie Kurzcode-Schnipsel oder Befehle innerhalb des Textes.
Durchgestrichen (): Den Text streichen, um Entfernung oder Überarbeitung anzuzeigen.
Hochschrift (): Zeigen Sie Text etwas oberhalb der Linie (nützlich für Fußnoten oder Mathematik).
Index (): Text etwas unterhalb der Zeile anzeigen (nützlich für Formeln).
Formatierung entfernen (): Alle angewendeten Stile löschen und zum Klartext zurückkehren.
Link einfügen (): Fügen Sie einen Hyperlink zum Text hinzu. Du kannst auf einen anderen Artikel innerhalb deines Projekts oder auf eine externe URL verlinken. Das funktioniert genauso wie das Hyperlinken von Text im Advanced WYSIWYG-Editor.
LaTeX (): Fügen Sie LaTeX-Ausdrücke für mathematische Inhalte hinzu.
Emoji (): Füge Emojis in den Inhalt ein.
HINWEIS
Sie können das
/Schrägstrichmenü im Variableneditor nutzen, um auf Formatierungswerkzeuge wie Überschrift 3 und Überschrift 4 zuzugreifen, und Sie können auch Elemente wie Link, LaTeX und Emoji einfügen.
Verwendung von Variablen in einer Artikel-/Kategorieseite
Du kannst deiner Artikel-/Kategorieseite mit drei Methoden eine Variable hinzufügen.
Methode 1: Verwendung der Syntax (Markdown-Editor)
Methode 2: Aus der Werkzeugleiste (Markdown, WYSIWYG und Advanced WYSIWYG)
Methode 3: Verwendung des Schrägstrichbefehls (/)
Methode 1: Verwendung der Syntax (Markdown-Editor)
Geben Sie im Markdown-Editor eine Variable ein. MergeCodeValue zwischen geschlossenen doppelten Krauseklammern.
Beispiel: {{variable. Haftungsausschluss}}
Du musst den genauen Mergecode-Wert kennen, um die gewünschte Variable hinzuzufügen. Die Variable funktioniert nicht, selbst wenn sich ein einziger Buchstabe ändert.
HINWEIS
Eingabe von Variable. Merge_Code_Value funktioniert nur im Markdown-Editor. Wenn du Advanced WYSIWYG editor benutzt, kannst du eine Variable über die Werkzeugleiste einfügen.
Methode 2: Aus der Werkzeugleiste (Markdown, WYSIWYG und Advanced WYSIWYG)
Klicken Sie auf das Content resources für Markdown
und WYSIWYG-Editor.
(oder)
Im erweiterten WYSIWYG-Editor verwenden Sie den Schrägstrich-Befehl/variables, um auf Variablen zuzugreifen.
Wählen Sie die Variable aus oder nutzen Sie die Leiste Suchvariablen, um den Variablennamen einzugrenzen.
Im erweiterten WYSIWYG-Editor erscheint der Variablen-Bereich zur Variablenauswahl . Mit der Maus über den gewünschten Variablennamen, um dessen Inhalt vorzusehen.
Wählen Sie die vorgesehene Variable aus, die eingefügt werden soll.
HINWEIS
Im Markdown- und WYSIWYG-Editor kannst du mehrere Variablen auf einmal auswählen.
Methode 3: Verwendung des Schrägstrichbefehls (/)
Benutze den Schrägstrich-Befehl
/variables, um die Option Variablen im Schrägstrichmenü zu öffnen.Suche nach oder wähle die Variable, die du einfügen möchtest. Fahre mit der Maus über eine Variable, um den vollständigen Inhalt vorzusehen.
Klicken Sie auf die Variable, um sie einzufügen.
Die eingefügte Variable zeigt den tatsächlichen Inhalt der Variablen mit einer gepunkteten Unterstrich im Editor an. So kannst du beim Bearbeiten den tatsächlichen Wert der Variablen sehen.
Klicken Sie auf die eingefügte Variable, um das Blasenmenü zu öffnen, wo Sie:
Wechsle über das Dropdown-Menü zu einer anderen Variable.
Als Text einfügen, wodurch die Variable durch ihren Inhalt als statischen Text ersetzt wird.
Entfernen Sie die Variable aus dem Artikel.
Artikel-/Kategorie-Seiten-Abhängigkeit anzeigen
Auf der Seite Variablen findest du die Spalte Verwendet in .
Klicken Sie in der Spalte "Verwendet" auf die Schaltfläche Anzeigen .
Das Referenzanzeigen-Panel erscheint, in dem Sie die Liste der Artikel/Kategorieseiten einsehen können, zu denen die Variable hinzugefügt wurde.
Klicken Sie auf den Artikel, um den Abschnitt zu erweitern.
Folgende Informationen finden Sie:
Die Artikelversion.
Der Projektarbeitsbereich und die Sprache.
Der Team-Accountname und das Profilbild, der die Variable hinzugefügt hat.
Im Artikel heißt es (Entwurf und veröffentlicht).
Die Zeit-/Datumsinformation, wann die Variable in der Artikel-/Kategorieseite eingefügt wurde.
Bearbeitung einer bestehenden Variablen
Um eine bestehende Variable zu bearbeiten:
Navigiere zu Content tools (
) in der linken Navigationsleiste im Knowledge base portal.Im linken Navigationsfenster navigieren Sie zu Content resources > Variables.
Die Seite Variablen erscheint. Du findest die Liste der Variablen, die du bereits hinzugefügt hast.
Fahre mit der Maus über die gewünschte Variable und klicke auf das Bearbeiten ()-Symbol.
Du kannst den Inhalt der Variablen bearbeiten. Der Name und der Merge-Code-Wert können nicht bearbeitet werden.
HINWEIS
Bearbeiten eines in einer Variablen hinzugefügten Links
Klicken Sie auf den Link, und Sie finden folgende Optionen:
Link öffnen (): Der Link öffnet sich im Tab. Das hilft, den Link zu überprüfen.
Bearbeiten (): Um die URL zu bearbeiten, den Text zu verlinken und die Option "Öffnen" in der neuen Registerkarte zu ändern.
Entlinken (): Um die URL zu entlinken und in Standardtext zu ändern. Die URL wird entlinkt, und nur der URL-Text wird angezeigt.
Kopieren (): Um den Link zu kopieren.
Nachdem Sie die Inhaltsbearbeitung abgeschlossen haben, klicken Sie auf die Schaltfläche "Aktualisieren ".
HINWEIS
Wenn Sie den Inhalt einer bestehenden Variablen in der Bibliothek bearbeiten, spiegelt sich die Inhaltsänderung in allen Artikeln/Kategorieseiten wider, die die jeweilige Variable enthalten.
Löschen einer Variablen
Um eine Variable zu löschen,
Navigiere zu Content tools (
) in der linken Navigationsleiste im Knowledge base portal.Im linken Navigationsfenster navigieren Sie zu Content resources > Variables.
Die Seite Variablen erscheint. Du findest die Liste der Variablen, die du bereits hinzugefügt hast.
Fahre mit der Maus über die gewünschte Variable und klicke auf das Löschen ()-Symbol.
Klicken Sie im Dialogfeld "Löschen" auf Ja.
Um mehrere Variablen massenhaft zu löschen
Wählen Sie mehrere beabsichtigte Variablen auf der Seite Variablen aus und klicken Sie oben in der Liste auf die Option Löschen .
HINWEIS
Wenn du eine Variable löschst, wird sie aus allen Artikeln entfernt, in denen sie referenziert wird.
Der Artikel selbst wird nicht geändert oder erneut veröffentlicht, wenn eine Variable gelöscht wird.
Auf der Knowledge Base-Seite passt sich der umgebende Inhalt automatisch an, sodass kein leerer Platz an der Stelle bleibt, wo die Variable entfernt wurde.
Im Portal wird die Variable durch den Platzhaltertext "Laden..." ersetzt. Du kannst das entweder durch eine andere Variable ersetzen oder es manuell löschen.
Übersetzung von Variablen
Man kann Variablen in mehreren Sprachen erstellen und verwalten. Dies stellt sicher, dass bei der Übersetzung Ihrer Artikel die Variablen mit der Sprache des Artikels übereinstimmen und so ein konsistentes und lokalisiertes Nutzererlebnis bieten.
Übersetzung neuer Variablen
Navigiere zu Content tools (
) in der linken Navigationsleiste im Knowledge base portal.Im linken Navigationsfenster navigieren Sie zu Content resources > Variables.
Klicken Sie auf Erstellen.
Im Dropdown-Menü Sprache wählen Sie die gewünschte Sprache aus (außer global).
Gib den Variablennamen und den Inhalt der Variablen auf Englisch (oder in deiner Standardsprache) ein.
Um den Inhalt in andere Sprachen zu übersetzen, klicken Sie auf das Dropdown-Menü "In andere Sprachen übersetzen ".
Wählen Sie die gewünschten Sprachen im Dropdown-Menü aus und klicken Sie auf Übersetzen.
HINWEIS
Die Standardsprache wird als Hauptsprache markiert.
Übersetzte Sprachen werden mit einem grünen Häkchen angezeigt, um anzuzeigen, dass die Übersetzung vollständig ist. Falls nötig, kannst du zu unübersetzten Sprachen navigieren und deren Übersetzung abschließen.
Sobald die Übersetzungen abgeschlossen sind, klicke auf Speichern, um die Variable zusammen mit ihren Übersetzungen zu speichern.
Wenn du zum Beispiel eine Variable für eine Begrüßungsnachricht auf Englisch erstellst, kannst du die Übersetzungsfunktion nutzen, um dieselbe Nachricht auf Französisch, Spanisch, Deutsch usw. hinzuzufügen.
Übersetzung bestehender Variablen
WICHTIG
Globale Variablen können nicht übersetzt werden.
Navigiere zu Content tools (
) in der linken Navigationsleiste im Knowledge base portal.Im linken Navigationsfenster navigieren Sie zu Content resources > Variables.
Klicken Sie auf die gewünschte Variable, die Sie übersetzen möchten.
Navigiere zu Übersetzen in andere Sprachen und wähle die gewünschte Sprache aus, die die Variable übersetzen muss.
Klicken Sie auf Übersetzen.
Falls nötig, kannst du in andere Sprachen navigieren und sie übersetzen.
Um den Inhalt neu zu übersetzen, klicken Sie erneut auf Übersetzen, wodurch die bestehende Übersetzung durch die neue überschrieben wird.
Wenn du die übersetzte Variable für eine bestimmte Sprache entfernen musst, klicke auf das Symbol More () und wähle Sprache entfernen.
Du kannst den Inhalt jederzeit neu übersetzen, falls nötig.
Wenn Sie fertig sind, klicken Sie auf Aktualisieren.
Häufig gestellte Fragen
Wie funktionieren Variablen?
Variablen ermöglichen es, spezifische Inhaltselemente wie Produktnamen oder Versionsnummern an einem Ort zu definieren. Das Aktualisieren der Variablen spiegelt die Änderung automatisch in allen relevanten Abschnitten wider, wenn sich dieser Inhalt ändert, um Einheitlichkeit zu gewährleisten.
Was ist der Vorteil, Variablen in meiner Dokumentation zu verwenden?
Durch die Verwendung von Variables sorgen Sie für Konsistenz in Ihrer Dokumentation und minimieren gleichzeitig den Bedarf an manuellen Updates. Dies spart Zeit, reduziert Fehler und sorgt für die Genauigkeit, insbesondere bei häufig wechselnden Informationen.
Kann ich meine Variablen in Document360 erstellen?
Document360 ermöglicht es Ihnen, benutzerdefinierte Variablen zu erstellen, die auf Ihre Dokumentationsbedürfnisse zugeschnitten sind. So können Sie die Funktion an die spezifische Terminologie und Elemente anpassen, die für Ihren Inhalt relevant sind.
Wie verwende ich Variablen in meinen Artikeln?
Füge die Variable über die Werkzeugleiste des Editors oder den Mergecode-Wert in den Artikelinhalt ein, und sie zieht die von dir definierten Informationen dynamisch ab, um Einheitlichkeit in deiner Dokumentation zu gewährleisten.
Können Variablen gleichzeitig über mehrere Artikel hinweg aktualisiert werden?
Wenn Sie eine Variable aktualisieren, wird die Änderung automatisch in allen Instanzen widergespiegelt, in denen diese Variable verwendet wird, was es erleichtert, konsistente Informationen in Ihrer gesamten Wissensdatenbank zu pflegen.
Sind Variablen auf bestimmte Inhaltsarten beschränkt?
Ja, Variablen können für begrenzte Text-, Nummern- oder linkbasierte Inhalte verwendet werden, von Produktnamen und Versionsnummern bis hin zu URLs und Kontaktinformationen.
Wie verbessern Variablen die Zusammenarbeit zwischen Teammitgliedern?
Variablen vereinfachen den Kollaborationsprozess, indem sie sicherstellen, dass alle dieselben genauen Informationen verwenden. Änderungen an einer Variablen werden sofort in allen Artikeln aktualisiert, um Unstimmigkeiten zu vermeiden.
Ist die Verwendung von Variables eine bewährte Praxis in der technischen Dokumentation?
Die Verwendung von Variablen ist eine Best Practice, die die Effizienz, Konsistenz und Genauigkeit der technischen Dokumentation verbessert. Es ist besonders wertvoll, wenn man mit dynamischen Informationen arbeitet, die häufige Aktualisierungen erfordern.
Kann ich Variablen in jede beliebige Sprache übersetzen?
Du kannst Variablen in jede Sprache deines Projekts übersetzen.
Wird die Definition eines variablen Begriffs, der auf der Knowledge Base-Seite erstellt wird, in der Suche und von Google indexiert?
Ja, die Definition eines variablen Begriffs, der auf der Knowledge Base (KB)-Seite erstellt wird, wird sowohl in der Suche der Seite als auch von Google indexiert. Sobald der Begriff hinzugefügt wurde, ist er auf der Website durchsuchbar und wird auch von Google gecrawlt und indexiert.