Artikel schreiben und Sammlungen organisieren
Ihr Hilfe-Center organisiert Artikel in Sammlungen und bietet Ihrem Team einen Rich-Text-Editor mit internen Verlinkungen, Versionsverlauf und Sichtbarkeitseinstellungen.
Sammlungen organisieren
Öffnen Sie Hilfe-Center → Artikel in der Dashboard-Seitenleiste, um Ihren Navigationsbaum zu verwalten.
Erstellen Sie eine Sammlung. Klicken Sie in der oberen Leiste auf Neue Sammlung, geben Sie einen Namen ein (bis zu 255 Zeichen; UserJot schlägt während der Eingabe automatisch ein Symbol vor, bis Sie manuell eines auswählen), wählen Sie ein Symbol aus und klicken Sie auf Erstellen. Neue Sammlungen erscheinen unten auf der obersten Ebene.
Sammlung bearbeiten. Klicken Sie mit der rechten Maustaste auf eine Sammlung und wählen Sie Bearbeiten…, um das Symbol, den Namen oder die Beschreibung (bis zu 500 Zeichen) zu ändern.
Verschachteln und neu anordnen. Ziehen Sie Sammlungen und Artikel im Baum per Drag-and-drop, um sie neu anzuordnen oder zu verschachteln, oder klicken Sie mit der rechten Maustaste darauf und wählen Sie Verschieben nach. Sammlungen können bis zu drei Ebenen tief verschachtelt werden.
Artikel auf oberster Ebene und nicht zugeordnete Artikel. Artikel auf der obersten Ebene erscheinen außerhalb aller Sammlungen und können ein eigenes Symbol haben (Rechtsklick → Symbol ändern…). Wenn Sie in der oberen Leiste auf Neuer Artikel klicken, wird unter Keine Sammlung ein nicht zugeordneter Entwurf erstellt. Nicht zugeordnete Artikel werden erst aufgeführt oder sind durchsuchbar, wenn Sie sie auf die oberste Ebene oder in eine Sammlung verschieben.
Sammlung löschen. Klicken Sie mit der rechten Maustaste auf eine Sammlung und wählen Sie Löschen…. Sammlungen werden dauerhaft gelöscht, ohne im Papierkorb abgelegt zu werden. Wenn die Sammlung Artikel enthält, wählen Sie eine andere Sammlung, die oberste Ebene oder Keine Sammlung als Ziel für Artikel verschieben nach aus (beim Verschieben in eine andere Sammlung werden die alten URLs der gelöschten Sammlung dorthin weitergeleitet).
Mit dem Editor schreiben
Jeder Artikel benötigt einen Titel (bis zu 255 Zeichen) und kann eine Beschreibung enthalten (bis zu 500 Zeichen; wird auf Karten und als Meta-Beschreibung verwendet). Außerdem verfügt jeder Artikel über einen Texteditor.
Drücken Sie in einer neuen Zeile /, um Blöcke einzufügen:
Text, Überschrift (H2) und Unterüberschrift (H3). Überschriften erzeugen automatisch stabile Abschnittsanker.
Aufzählung, Nummerierte Liste, Zitat, Codeblock (mit Sprachauswahl) und Trennlinie.
Bild (Dateien von Ihrem Computer hochladen; klicken Sie auf ein Bild, um Alternativtext oder eine Bildunterschrift hinzuzufügen, jeweils bis zu 500 Zeichen).
Tabelle (wird als 3×3-Tabelle mit Kopfzeile und schwebenden Steuerelementen für Zeilen und Spalten eingefügt).
Hinweis-, Tipp- und Warnung-Infoboxen sowie einklappbare Akkordeon-Blöcke (Titel mit 1 bis 200 Zeichen). Im Dashboard-Editor können Infoboxen und Akkordeons nicht ineinander verschachtelt werden (über die API oder einen HTML-Import kann eine Infobox in einem Akkordeon erscheinen; Infoboxen in Infoboxen, Akkordeons in Infoboxen und Akkordeons in Akkordeons werden jedoch abgelehnt).
Videos von YouTube, Loom oder Vimeo einbetten (oder einen einfachen Link zu einem dieser Anbieter in eine eigene Zeile einfügen).
Markieren Sie Text, um Fett, Kursiv, Durchgestrichen, Code, Taste (Formatierung für Tastenkürzel) oder Links anzuwenden. Code und Taste lassen sich nicht mit anderen Inline-Formatierungen kombinieren, und Taste-Text darf weder < noch > enthalten. Dokumente unterstützen bis zu 1 MB JSON, 512 KB Markdown, 5.000 Knoten und 32 Ebenen Blockverschachtelung.
Entwürfe werden während der Eingabe automatisch gespeichert. Drücken Sie ⌘S / Ctrl+S, um manuell zu speichern, drücken Sie ⌘⇧\ / Ctrl+Shift+\, um die Seitenleiste mit der Artikelliste ein- oder auszublenden, schalten Sie unten rechts die Vorschau ein, um die Leseransicht zu prüfen, oder klicken Sie unten links auf Tippgeräusch, um optionale mechanische Tastaturklänge auszuwählen (Alpaca, Cream, Mint, Mochi, Frost oder Aus); die Lautstärke lässt sich über einen Schieberegler einstellen.
Markdown-Dialekt des Help Centers
Die REST API, der MCP-Server, Seite kopieren und .md-Endpunkte verwenden GitHub Flavored Markdown mit folgenden Erweiterungen:
<Note>,<Tip>und<Warning>für Infobox-Blöcke<Accordion title="...">für einklappbare Abschnitte{#custom-id}am Ende einer Überschrift, um einen stabilen Anker festzulegen<kbd>...</kbd>für Inline-TastenkürzelInterne Links in der Form
/articles/<slug>oder/collections/<slug>(optional mit#heading)
Artikel miteinander verlinken
Klicken Sie in der Auswahl-Symbolleiste auf die Link-Schaltfläche, um Link hinzufügen zu öffnen. Durchsuchen Sie Ihr Help Center nach Artikeln, Sammlungen und Überschriften veröffentlichter Artikel (die Suche nach Überschriften erfordert mindestens 2 Zeichen und liefert bis zu 8 Treffer) oder fügen Sie eine externe https://-URL ein. Wenn Sie die URL eines Ihrer eigenen Help-Center-Artikel einfügen, wird daraus ein interner Verweis, der auch dann funktioniert, wenn sich der Slug des Zielartikels ändert.
Wenn ein verlinktes Ziel später nicht mehr veröffentlicht, in den Papierkorb verschoben oder gelöscht wird, hebt der Editor den Link direkt im Text hervor, damit Sie ihn korrigieren können. Die Liste Verlinkt von in der rechten Artikel-Seitenleiste zeigt bis zu acht veröffentlichte Artikel an, die auf den aktuellen Artikel verlinken.
Sichtbarkeit, Links und Schlüsselwörter verwalten
Öffnen Sie die rechte Artikel-Seitenleiste, um festzulegen, wie Leser einen Artikel finden:
Einstellung | Funktion |
|---|---|
Sichtbarkeit | Wählen Sie Öffentlich (wird aufgeführt, ist durchsuchbar und in |
Sammlung | Platzieren Sie den Artikel auf der obersten Ebene, in einer Sammlung oder lassen Sie ihn unter Keine Sammlung. |
Link | Klicken Sie auf |
In Suchmaschinen anzeigen | Lassen Sie die Indexierung dieses Artikels durch Suchmaschinen zu oder blockieren Sie sie. Damit der Artikel indexiert wird, muss er außerdem öffentlich und platziert sein und Ihr Help Center muss auf Live eingestellt sein. |
Schlüsselwörter | Fügen Sie verborgene Suchbegriffe für die aktuelle Sprache hinzu (bis zu 50 Schlüsselwörter mit jeweils 64 Zeichen). Drücken Sie die Eingabetaste oder ein Komma, um jeden Begriff hinzuzufügen. |
Über die Statuskarte oben in der rechten Seitenleiste können Sie außerdem einen Autor oder Kein Autor zuweisen.
Veröffentlichen, Versionsverlauf und Papierkorb
Veröffentlichen. Klicken Sie auf Veröffentlichen (oder Änderungen veröffentlichen; Tastenkürzel ⌘↵). Vor der Veröffentlichung weist ein Popover auf fehlenden Alternativtext für Bilder oder fehlerhafte interne Links hin. Wenn Sie einen veröffentlichten Artikel aktualisieren, deaktivieren Sie bei kleinen Tippfehlerkorrekturen die Option Als aktualisiert anzeigen, damit das öffentliche Aktualisierungsdatum unverändert bleibt.
Veröffentlichung aufheben. Öffnen Sie Weitere Aktionen (
⋮) → Veröffentlichung aufheben, um die aktuelle Sprache offline zu nehmen und ihren Entwurf sowie den Versionsverlauf beizubehalten.Versionsverlauf. Wählen Sie in der rechten Seitenleiste unter Verlauf einen beliebigen Eintrag aus, um ihn schreibgeschützt anzusehen (drücken Sie Esc, um die Vorschau zu verlassen). Klicken Sie anschließend auf Diese Version wiederherstellen, um sie in Ihren Entwurf zu übernehmen (sie bleibt unveröffentlicht, bis Sie auf Änderungen veröffentlichen klicken).
Übersetzungen vergleichen. Aktivieren Sie beim Bearbeiten eines übersetzten Artikels in der oberen Leiste (auf breiten Bildschirmen) die Option Vergleichen, um das veröffentlichte Original neben der Übersetzung anzuzeigen. Geänderte, hinzugefügte und entfernte Blöcke werden hervorgehoben.
In den Papierkorb verschieben und wiederherstellen. Öffnen Sie Weitere Aktionen (
⋮) → In den Papierkorb verschieben, um einen Artikel sofort zu entfernen. Artikel im Papierkorb können 30 Tage lang wiederhergestellt werden (Slug und Weiterleitungen bleiben dabei reserviert), bevor sie endgültig gelöscht werden. Wenn Sie einen Artikel im Papierkorb öffnen, wird die Schaltfläche Aus dem Papierkorb wiederherstellen angezeigt.
Nächste Schritte
Übersetzen Sie Artikel über Sprachen in weitere Sprachen.
Synchronisieren Sie Ihre veröffentlichten Artikel mit Juno unter Juno Ihr Produkt beibringen.