Pläne, die das Hinzufügen von Variablen unterstützen
Professionell | Geschäft | Unternehmen |
---|---|---|
Sie können Variablen wiederverwenden, wenn Sie denselben textbasierten Inhalt an mehreren Stellen verwenden, die sich im Laufe der Zeit ändern können (z. B. Feldnamen, Kontaktnummern, Adressen, Haftungsausschlüsse usw.). Eine Variable in Document360 ist ein wiederverwendbares Element, das dazu beiträgt, die Konsistenz und Effizienz in verschiedenen Dokumentationsabschnitten zu gewährleisten. Durch die Verwendung von Variablen können die Mitwirkenden an Ihren Artikeln die Informationen einfach an einem Ort aktualisieren, und sie werden automatisch in der gesamten Dokumentation widergespiegelt, um die Genauigkeit zu gewährleisten und redundanten Aufwand zu reduzieren.
Angenommen, Sie möchten Ihre Kontaktinformationen in mehreren Instanzen 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, können Sie die Variable allein aktualisieren, anstatt sie in allen Instanzen zu aktualisieren.
(Kontakt: +1 897564231/support@serverless.com)
Erstellen einer Variablen
Um eine Variable zu erstellen,
Navigieren Sie zu Documentation () > Content tools > Content reuse > Variables im Wissensdatenbank-Portal.
Die Seite "Variablen " wird angezeigt. Wenn Sie zuvor Variablen hinzugefügt haben, werden diese hier aufgelistet.
Klicken Sie oben auf Variable erstellen , um sprachspezifische Variablen (Global, Englisch, Französisch usw.) auszuwählen, die Ihrem Projekt hinzugefügt wurden.
Geben Sie den Namen für Ihre Variable ein.
ANMERKUNG
Der Variablenname kann Buchstaben, Zahlen, Bindestriche und Unterstriche mit einer maximalen Länge von 30 Zeichen enthalten.
Der Wert des Merge-Codes ist der Variablenname, der zusammen mit dem Variablen-Tag in Ihrem Editor angezeigt wird.
Wenn der Variablenname z. B . "Haftungsausschluss" lautet, lautet der Wert des Merge-Codes {{variable. Haftungsausschluss}}.
In der Dropdown-Liste Sprachauswahl ist die Standardauswahl Global (in allen Sprachen verfügbar). Bei Bedarf können Sie jedoch eine gewünschte verfügbare Sprache auswählen, um eine sprachspezifische Variable zu erstellen.
Geben Sie im Feld Inhalt den Inhalt der Variablen ein.
ANMERKUNG
Die Zeichenbeschränkung für den Inhalt der Variablen beträgt 100 Zeichen mit Leerzeichen. Wenn Sie längere Texte, Ausdrücke, Medien, Tabellen oder Codeblöcke hinzufügen möchten, verwenden Sie Snippets. Weitere Informationen finden Sie im Artikel auf Snippet.
Formatierungsoptionen
Verwenden Sie die folgenden Optionen für die Textformatierung, um den variablen Inhalt zu formatieren
ein. Grundlegende Textformatierung:
• Fett
• Kursiv
• Durchgestrichen
• Unterstreichen
• Schriftgröße (8 bis 36)
b. Zusätzliche Formatierung:
Klicken Sie auf das Symbol Mehr Text , um auf Folgendes zuzugreifen:
• Schriftfamilie (Wählen Sie aus der Liste der Schriftarten)
• Textfarbe (Farbwähler oder HEX-Code)
• Hintergrundfarbe (Farbwähler oder HEX-Code)
• Tiefgestellt
• Hochgestellt
• Übersichtliche Formatierung
c. Link einfügen - Um einen Hyperlink hinzuzufügen.
Klicken Sie auf das Symbol Link einfügen .
Geben Sie die URL ein und fügen Sie dem Link Text hinzu.
Wählen Sie bei Bedarf In neuem Tab öffnen aus.
Klicken Sie auf Einfügen.
Klicken Sie auf die Schaltfläche Variable erstellen .
Die neu erstellte Variable wird auf der Seite "Variablen " angezeigt, wo sie nach Bedarf bearbeitet oder gelöscht werden kann.
Verwenden einer Variablen auf einer Artikel-/Kategorieseite
Sie können eine Variable zu Ihrer Artikel-/Kategorieseite hinzufügen, indem Sie zwei Methoden verwenden.
Methode 1: Verwenden der Syntax (Markdown-Editor)
Geben Sie im Markdown-Editor eine Variable ein. MergeCodeValue zwischen geschlossenen doppelten geschweiften Klammern.
Beispiel: {{Variable. Haftungsausschluss}}
Sie müssen den genauen Wert des Merge-Codes kennen, um die gewünschte Variable hinzuzufügen. Die Variable funktioniert auch dann nicht, wenn sich ein einzelner Buchstabe ändert.
ANMERKUNG
Eingabe der Variablen. Merge_Code_Value funktioniert nur im Markdown-Editor. Wenn Sie Advanced WYSIWYG editorverwenden, können Sie eine Variable über die Symbolleiste einfügen.
Methode 2: Über die Symbolleiste (Markdown, WYSIWYG und Advanced WYSIWYG)
Klicken Sie auf das Symbol für die Wiederverwendung von Inhalten () für den Markdown- und WYSIWYG-Editor.
(oder)
Verwenden Sie im erweiterten WYSIWYG-Editor den Befehl/variables
slash, um auf Variablen zuzugreifen.Wählen Sie die Variable aus oder verwenden Sie die Variablensuchleiste, um den Variablennamen einzugrenzen.
Im erweiterten WYSIWYG-Editor wird der Bereich Variablen für die Variablenauswahl angezeigt. Bewegen Sie den Mauszeiger über den gewünschten Variablennamen, um eine Vorschau des Inhalts anzuzeigen.
Wählen Sie die gewünschte Variable aus, die eingefügt werden soll.
ANMERKUNG
Im Markdown- und WYSIWYG-Editor können Sie mehrere Variablen auf einmal auswählen.
Seite "Variablen"
Sie können eine Variable auf der Seite "Variablen " anzeigen, bearbeiten oder löschen.
Navigieren Sie im Wissensdatenbank-Portal zu Dokumentation () > Inhaltstools > zur Wiederverwendung > Variablen von Inhalten.
Die Seite Variablen wird angezeigt, auf der Sie die Liste der Variablen finden, die Sie bereits hinzugefügt haben.
Sprachen: Um die Variablen in Global oder einer bestimmten Sprache zu filtern.
Variable suchen: Durchsuchen Sie die Variablenliste anhand des Namens.
Verwendet in: Wenn eine Variable nicht zu einer Artikel-/Kategorieseite hinzugefügt wird, lautet
-
der Status . Wenn eine Variable zu einer Artikel-/Kategorieseite hinzugefügt wird, können Sie auf die Schaltfläche Ansicht klicken, um die Liste der Artikel-/Kategorieseiten anzuzeigen, die die Variable enthalten.Sprache: Die gewünschte Sprache jeder Variablen.
Letzte Änderung: Der Zeitpunkt, zu dem der Variableninhalt zuletzt aktualisiert wurde.
Vorschau: Klicken Sie auf den Namen der Variablen, und Sie können den Inhalt der Variablen anzeigen.
Fortschritt: Klicken Sie auf das Globussymbol, um den Fortschritt der Variablen in mehreren Sprachen anzuzeigen.
Symbol Bearbeiten (): Um den Inhalt der Variablen zu bearbeiten. Nachdem Sie die Änderungen vorgenommen haben, klicken Sie auf Aktualisieren.
Symbol "Löschen " (): Um die Variable zu entfernen.
Abhängigkeiten von Artikel-/Kategorieseiten anzeigen
Auf der Seite "Variablen " finden Sie die Spalte "Verwendet in ".
Klicken Sie in der Spalte Verwendet in auf die Schaltfläche Ansicht .
Das Fenster "Referenzen anzeigen " wird angezeigt, in dem Sie die Liste der Artikel-/Kategorieseiten anzeigen können, zu denen die Variable hinzugefügt wurde.
Klicken Sie auf den Artikel, um den Abschnitt zu erweitern.
Folgende Informationen finden Sie hier:
Die Artikelversion.
Der Arbeitsbereich und die Sprache des Projekts.
Der Name des Teamkontos und das Profilbild, das die Variable hinzugefügt hat.
Der Artikel lautet (Veröffentlicht, Entwurf, Neuer Artikel).
Die Zeit-/Datumsangaben, zu denen die Variable auf der Artikel-/Kategorieseite eingefügt wurde.
Bearbeiten einer vorhandenen Variablen
Navigieren Sie im Wissensdatenbank-Portal zu Dokumentation () > Inhaltstools > zur Wiederverwendung von Inhalten > Variablen .
Die Seite "Variablen " wird angezeigt. Hier finden Sie die Liste der Variablen, die Sie bereits hinzugefügt haben.
Bewegen Sie den Mauszeiger über die gewünschte Variable und klicken Sie auf das Symbol Bearbeiten ().
Sie können den Inhalt der Variablen bearbeiten. Der Wert für den Namen und den Zusammenführungscode kann nicht bearbeitet werden.
ANMERKUNG
Bearbeiten eines Links, der in einer Variablen hinzugefügt wurde
Klicken Sie auf den Link, um die folgenden Optionen zu finden:
Link öffnen (): Der Link öffnet sich im Tab. Dies hilft bei der Überprüfung des Links.
Style (): Style hat zwei Optionen.
Grün: Um die Textfarbe des Links in Grün zu ändern.
Dick: Um die Dicke des Linktexts zu erhöhen.
Bearbeiten (): Zum Bearbeiten der URL, des Linktexts und der Option "In neuem Tab öffnen" ändern.
Verknüpfung aufheben (): Um die Verknüpfung der URL aufzuheben und sie in Standardtext zu ändern. Die Verknüpfung der URL wird aufgehoben und nur der URL-Text wird angezeigt.
Nachdem Sie die Inhaltsbearbeitung abgeschlossen haben, klicken Sie auf die Schaltfläche Aktualisieren .
ANMERKUNG
Wenn Sie den Inhalt einer vorhandenen Variablen in der Bibliothek bearbeiten, wird die Inhaltsänderung in allen Artikeln/Kategorieseiten angezeigt, die die entsprechende Variable enthalten.
Löschen einer Variablen
Navigieren Sie zu Dokumentation () > Inhaltstools > Wiederverwendung von Inhalten > Variablen im Wissensdatenbankportal.
Die Seite "Variablen " wird angezeigt. Hier finden Sie die Liste der Variablen, die Sie bereits hinzugefügt haben.
Bewegen Sie den Mauszeiger über die gewünschte Variable und klicken Sie auf das Symbol Löschen ().
Klicken Sie in der Bestätigungsaufforderung auf Ja .
So löschen Sie mehrere Variablen in großen Mengen
Wählen Sie auf der Seite "Variablen" mehrere gewünschte Variablen aus und klicken Sie oben in der Liste auf die Option "Löschen ".
Variablen übersetzen
Sie können Variablen in mehreren Sprachen erstellen und verwalten. Dadurch wird sichergestellt, dass bei der Übersetzung Ihrer Artikel die Variablen mit der Sprache des Artikels übereinstimmen, was eine konsistente und lokalisierte Benutzererfahrung bietet.
Neue Variablen übersetzen
Navigieren Sie zu den Tools Dokumentation () > Inhalt > Wiederverwendung von Inhalten > Variablen im Wissensdatenbankportal.
Klicken Sie auf Variable erstellen.
Wählen Sie in der Dropdown-Liste Sprache die gewünschte Sprache aus (außer global).
Geben Sie den Variablennamen und den Inhalt der Variablen in Englisch (oder Ihrer 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ünschte(n) Sprache(n) aus dem Dropdown-Menü aus und klicken Sie auf Übersetzen.
ANMERKUNG
Die Standardsprache wird als Main markiert.
Übersetzte Sprachen werden mit einem grünen Häkchen gekennzeichnet, um anzuzeigen, dass die Übersetzung vollständig ist. Bei Bedarf können Sie zu nicht übersetzten Sprachen navigieren und deren Übersetzung abschließen.
Sobald die Übersetzungen abgeschlossen sind, klicken Sie auf Variable erstellen , um die Variable zusammen mit ihren Übersetzungen zu speichern.
Wenn Sie beispielsweise eine Variable für eine Begrüßungsnachricht auf Englisch erstellen, können Sie die Übersetzungsfunktion verwenden, um dieselbe Nachricht auf Französisch, Spanisch, Deutsch usw. hinzuzufügen.
Übersetzen vorhandener Variablen
ANMERKUNG
Globale Variablen können nicht übersetzt werden.
Klicken Sie auf die gewünschte vorhandene Variable, die Sie übersetzen möchten.
Navigieren Sie zu In andere Sprachen übersetzen und wählen Sie die gewünschte Sprache aus, in die die Variable übersetzt werden soll.
Klicken Sie auf Übersetzen.
Bei Bedarf können Sie in andere Sprachen navigieren und diese übersetzen.
Um den Inhalt erneut zu übersetzen, klicken Sie erneut auf Übersetzen, wodurch die vorhandene Übersetzung mit der neuen überschrieben wird.
Wenn Sie die übersetzte Variable für eine bestimmte Sprache entfernen müssen, klicken Sie auf Sprache entfernen.
Sie können den Inhalt bei Bedarf jederzeit neu übersetzen.
Häufig gestellte Fragen
Wie funktionieren Variablen?
Mit Variablen können Sie bestimmte Inhaltselemente, wie z. B. Produktnamen oder Versionsnummern, an einem Ort definieren. Das Aktualisieren der Variablen spiegelt automatisch die Änderung in allen relevanten Abschnitten wider, wenn sich dieser Inhalt ändert, um die Einheitlichkeit zu gewährleisten.
Was ist der Vorteil der Verwendung von Variablen in meiner Dokumentation?
Durch die Verwendung von Variablen stellen Sie die Konsistenz Ihrer Dokumentation sicher und minimieren gleichzeitig den Bedarf an manuellen Updates. Dies spart Zeit, reduziert Fehler und behält die Genauigkeit bei, insbesondere beim Umgang mit sich häufig ändernden Informationen.
Kann ich meine Variablen in Document360 erstellen?
Mit Document360 können Sie benutzerdefinierte Variablen erstellen, die auf Ihre Dokumentationsanforderungen zugeschnitten sind. Auf diese Weise können Sie das Feature an die spezifische Terminologie und die Elemente anpassen, die für Ihre Inhalte relevant sind.
Wie verwende ich Variablen in meinen Artikeln?
Fügen Sie die Variable mithilfe der Symbolleiste des Editors oder des Merge-Code-Werts in den Artikelinhalt ein, und die von Ihnen definierten Informationen werden dynamisch abgerufen, um die Einheitlichkeit Ihrer Dokumentation zu gewährleisten.
Können Variablen in mehreren Artikeln gleichzeitig aktualisiert werden?
Wenn Sie eine Variable aktualisieren, wird die Änderung automatisch in allen Instanzen widergespiegelt, in denen diese Variable verwendet wird, sodass Sie auf einfache Weise konsistente Informationen in Ihrer gesamten Wissensdatenbank verwalten können.
Sind Variablen auf bestimmte Arten von Inhalten beschränkt?
Ja, Variablen können für eingeschränkten Text-, Zahlen- oder Link-basierten Inhalt verwendet werden, von Produktnamen und Versionsnummern bis hin zu URLs und Kontaktinformationen.
Wie verbessern Variablen die Zusammenarbeit zwischen Teammitgliedern?
Variablen optimieren den Prozess der Zusammenarbeit, indem sie sicherstellen, dass jeder die gleichen genauen Informationen verwendet. Änderungen an einer Variablen werden sofort in allen Artikeln aktualisiert, wodurch Unstimmigkeiten vermieden werden.
Ist die Verwendung von Variablen eine Best Practice in der technischen Dokumentation?
Die Verwendung von Variablen ist eine bewährte Methode, die die Effizienz, Konsistenz und Genauigkeit der technischen Dokumentation verbessert. Dies ist besonders wertvoll, wenn Sie mit dynamischen Informationen arbeiten, die häufig aktualisiert werden müssen.
Kann ich Variablen in jede Sprache übersetzen?
Sie können Variablen in jede Sprache Ihres Projekts übersetzen.
Wird die Definition eines variablen Begriffs, der auf der Wissensdatenbank-Website erstellt wird, in der Suche und von Google indiziert?
Ja, die Definition eines variablen Begriffs, die auf der Knowledge Base-Website (KB) erstellt wird, wird sowohl in der Suche der Website als auch von Google indiziert. Sobald der Begriff hinzugefügt wurde, wird er auf der Website durchsuchbar und wird auch von Google gecrawlt und indiziert.