Ein Snippet ist ein wiederverwendbarer Inhaltsblock: Text, Absätze, Tabellen, Bilder, Aufrufe, Codeblöcke oder jede Kombination, die man einmal erstellt und in mehrere Artikel einfügt. Wenn du einen Ausschnitt aktualisierst, wird die Änderung automatisch in jedem Artikel angezeigt, der ihn verwendet. Ausschnitte werden in einer zentralen Bibliothek innerhalb von Document360 gespeichert und sind für die Leser als separates Element unsichtbar. Auf der Wissensdatenbank werden Ausschnittinhalte als normale Artikelinhalte dargestellt.
Warum Schnipsel verwenden
Snippets beheben ein häufiges Dokumentationsproblem: Inhalte, die in mehreren Artikeln erscheinen, müssen an mehreren Orten gepflegt werden. Ohne Ausschnitte bedeutet das Aktualisieren eines Produkt-Disclaimers, einer Support-Kontaktsperre oder einer geteilten Warnung, jeden Artikel, der diesen enthält, zu finden und jeden einzeln zu bearbeiten. Eine übersehene Instanz führt zu inkonsistenten Informationen.
Mit Ausschnitten lebt dieser Inhalt an einem Ort:
- Eine einzige Wahrheitsquelle. Ein Edit, überall regelmäßige Updates.
- Geringere Wartungskosten. Keine Suche zwischen Artikeln nach wiederholtem Inhalt.
- Konsistenz im großen Maßstab. Die gleiche Warnung, Anmerkung oder Stufe erscheint in allen Artikeln identisch.
- Schnelleres Autoren. Autoren fügen vordefinierte Blöcke ein, anstatt neu zu tippen oder zu kopieren.
Schnipsel vs. Variablen
Document360 bietet zwei Tools zur Wiederverwendung von Inhalten an. Die Wahl des richtigen hängt davon ab, was du wiederverwendest.
| Ausschnitte | Variablen | |
|---|---|---|
| Inhaltstyp | Formatierte Blöcke wie Absätze, Tabellen, Bilder, Aufrufe und Code. | Klartextwerte wie Namen, Zahlen, URLs und kurze Phrasen. |
| Typische Verwendung | Haftungsausschlüsse, gemeinsame Schritte, Kontaktsperren, wiederholte Warnungen. | Produktnamen, Versionsnummern, Support-E-Mail-Adressen. |
| Zeichenbegrenzung | Kein Zeichenlimit. | 300 Zeichen. |
| Kann Formatierung enthalten? | Ja, vollständige Editor-Formatierung. | Nein, nur Text. |
| Kann man andere Snippets nesten? | Ja, nur Markdown-Schnipsel. | Nein. |
| Eingefügt über | Syntax von Werkzeugleiste oder Merge-Code. | Toolbar, Code-Syntax oder Schrägstrich-Befehl. |
Fang mit Snippets an
Erstellen und verwalten Sie Schnipsel
Erstellen Sie einen Snippet, wählen Sie Ihren Editor, verwenden Sie Eddy AI beim Entwurf und verwalten Sie Snippets von der Snippets-Seite – bearbeiten, löschen, in Bulk löschen und Abhängigkeiten anzeigen.
Erfahren Sie mehr →Verwenden und übersetzen Sie Ausschnitte
Fügen Sie Ausschnitte mit drei Methoden in Artikel ein, übersetzen Sie Ausschnitte für mehrsprachige Wissensdatenbanken und beheben Sie häufige Probleme.
Erfahren Sie mehr →Best Practices
- Verwenden Sie Ausschnitte für Inhalte, die in drei oder mehr Artikeln erscheinen. Wenn derselbe Block nur an ein oder zwei Stellen erscheint, ist es einfacher, diese direkt zu bearbeiten, als einen Ausschnitt zu erstellen und zu verwalten.
- Halte jeden Ausschnitt auf ein einziges Ziel. Ein Ausschnitt, der eine einzige, spezifische Funktion wie einen Haftungsausschluss, eine Kontaktsperre oder eine geteilte Warnung erfüllt, lässt sich leichter wiederverwenden und aktualisieren als einer, der nicht zusammenhängende Inhalte bündelt.
- Benennen Sie Ausschnitte beschreibend. Verwenden Sie ein Namensmuster, das den Inhaltstyp und Zweck widerspiegelt, zum Beispiel
[Warning] Unsaved changesoder[Contact] Support block. Konsistente Namen machen die Bibliothek leicht zu scannen und verringern die Wahrscheinlichkeit, den falschen Ausschnitt einzufügen. - Überprüfen Sie Abhängigkeiten, bevor Sie bearbeiten oder löschen. Änderungen an einem Ausschnitt gelten sofort für alle Artikel, die ihn verwenden, einschließlich veröffentlichter. Verwenden Sie die Spalte "Verwendet darin ", um die Auswirkungen zu überprüfen, bevor Sie Änderungen vornehmen.
- Verwende keine Variablen in Schnipseln. Variablen in Ausschnitten werden in der Editor-Vorschau oder in PDF-Exporten nicht korrekt dargestellt. Verwalte dynamische Werte getrennt vom Snippet-Inhalt.
- Übersetze Ausschnitte zusammen mit Artikeln. Wenn deine Wissensdatenbank mehrere Sprachen unterstützt, übersetze Ausschnitte gleichzeitig mit den Artikeln, die sie verwenden. Ein Ausschnitt ohne Übersetzung zeigt den Standardwert der Sprache den Lesern in anderen Regionen an.