Kategorientypen

In Document360 hat jede Kategorie einen Typ, der bestimmt, wie sie sowohl im Knowledge Base-Portal als auch auf der Knowledge Base-Seite aussieht und sich verhält. Die Wahl des richtigen Typs hilft Ihnen, eine klare, navigierbare Struktur für Ihre Leser zu schaffen. Es gibt vier Kategorientypen: Ordner, Index, Seite und GitHub.

Kategorientypen auf einen Blick

Ordner

Der Ordnertyp ist der Standard- und am häufigsten verwendete Kategorietyp. Es fungiert als reiner Container, der Artikel und Unterkategorien unter einem gemeinsamen Thema gruppiert, ohne eine eigene URL oder Inhaltsseite auf der Knowledge Base-Seite zu generieren.

Verwenden Sie den Ordner, wenn:

• Du brauchst eine Gruppenübersicht für ein breites Themengebiet.
• Die Kategorie benötigt keinen teilbaren Link.
• Sie möchten, dass die Leser in Unterkategorien oder Artikel navigieren, anstatt auf einer Kategorieseite zu landen.

Schlüsselmerkmale:

• Für diesen Kategorietyp wird keine URL generiert.
• Unterstützt Massenoperationen: Hide (), Unhide (), Delete (), Move () und Star () für Artikel innerhalb der Kategorie.
• Das Kategorie-Symbol kann mit einem Emoji angepasst werden.

Index

Der Index-Typ generiert eine eigene URL und zeigt eine strukturierte Übersicht aller Artikel innerhalb der Kategorie an. Wenn Leser auf einer Index-Kategorie auf der Wissensdatenbank klicken, sehen sie eine Liste von Artikeln, darunter Titel, Mitwirkende, zuletzt aktualisiertes Datum, Status und Tags, bevor sie einen bestimmten Artikel öffnen.

Verwenden Sie Index, wenn:

• Sie möchten, dass die Leser einen Überblick über den Inhalt einer Kategorie bekommen, bevor sie sich darauf einlassen.
• Die Kategorie benötigt eine teilbare, verlinkbare URL.
• Du brauchst einen strukturierten Einstiegspunkt für einen großen Teil deiner Wissensbasis.

Schlüsselmerkmale:

• Ein einzigartiger Slug wird erzeugt. Sie können Index-Kategorie-Links teilen und Weiterleitungsregeln darauf anwenden.
• Unterstützt die gleichen Massenoperationen wie Ordner: Ausblenden, Unhide, Delete, Move und Star.
• Unterstützt SEO-Einstellungen (Meta-Titel, Slug, Beschreibung) über das Mehr-()-Symbol > SEO.

Portalansicht:

Ansicht der Wissensdatenbank:

Wenn Leser auf eine Index-Kategorie klicken, sehen sie den Kategorietitel sowie die Anzahl der Artikel und Unterkategorien, die sie enthält.

Page

Der Seitentyp verhält sich wie ein regulärer Artikel. Sie können darin Inhalte mit dem Markdown-, WYSIWYG- oder Advanced WYSIWYG-Editor schreiben, formatieren und veröffentlichen. Es kann weiterhin Unterkategorien und Artikel darunter enthalten, was es für Sektionslandingpages eignet, die auch als Navigationseltern dienen.

Verwenden Sie die Seite wenn:

• Sie möchten eine Kategorie mit eigenem schriftlichem Inhalt, wie zum Beispiel einer Abschnittsübersicht oder Einleitung.
• Sie benötigen die vollständige Artikelfunktionalität (SEO-Einstellungen, Slug, Status, Überarbeitungshistorie) auf Kategorieebene.
• Die Kategorie muss sowohl Inhalte enthalten als auch als Elternteil für Unterkategorien fungieren.

Schlüsselmerkmale:

• Verhält sich genau wie ein normaler Aufsatz. Du kannst den Titel, den Slug ändern und alle die gleichen Aktionen auf Artikelebene ausführen.
• Unterstützt SEO-Einstellungen über das More ()-Symbol > SEO.
• Im Gegensatz zu einem normalen Artikel kann eine Seitenkategorie Unterkategorien und zusätzliche Artikel darunter enthalten.

Portalansicht:

Ansicht der Wissensdatenbank:

GitHub

Der GitHub-Typ synchronisiert Dokumentationsinhalte direkt aus einem verbundenen GitHub-Repository in Ihre Wissensdatenbank. Jeder Branch im Repository erscheint als Artikel innerhalb der Kategorie, der durch ein Branch-Icon gekennzeichnet ist. Wann immer ein Commit in das verbundene Repository gepusht wird, zieht Document360 automatisch die aktualisierten Markdown-Dateien ab und veröffentlicht sie.

Verwenden Sie GitHub, wenn:

• Deine Dokumentation befindet sich neben deinem Code in einem GitHub-Repository und wird in GitHub gepflegt.
• Du willst versionskontrollierte Dokumente, die automatisch synchron mit Code-Releases bleiben.
• Ihr Team bevorzugt es, Markdown in einem lokalen Editor zu schreiben, statt im Document360-Editor.

Schlüsselmerkmale:

• Inhalte, die von GitHub synchronisiert werden, sind in Document360 schreibgeschützt. Alle Änderungen müssen im Quell-GitHub-Repository vorgenommen werden.
• Nur der Hauptzweig wird für die Synchronisation unterstützt.
• Jeder Branch im verbundenen Repository erscheint als Artikel mit einem Branch-Icon im Portal.
• Nutzer können keine Artikel in einer GitHub-Kategorie bearbeiten oder veröffentlichen. Alle Änderungen müssen aus dem GitHub-Repository stammen.
• Das GitHub-Icon wird nur für öffentliche Kategorien angezeigt.
• Neue Artikel können in Document360 für von GitHub synchronisierte Kategorien nicht erstellt werden.

Vergleich von Kategorietypen

Änderung des Kategorientyps

Du kannst jederzeit den Typ einer Kategorie wechseln, ohne Inhalte zu verlieren.

1. Navigiere in der linken Navigationsleiste zu Dokumentation () ().
2. Mit der Maus über die Kategorie im Bereich Kategorien & Artikel fahren.
3. Klicken Sie auf das More ()-Symbol und wählen Sie den Typ ändern.
4. Wählen Sie den neuen Kategorientyp aus und klicken Sie auf Aktualisieren.

Best Practices

• Verwenden Sie den Ordner für Top-Level-Kategorien, die ausschließlich zur Navigation existieren. Es ist der einfachste Typ und erzeugt keine unnötigen URLs.
• Verwenden Sie Index für große Abschnitte, in denen Leser davon profitieren, eine Artikelübersicht zu sehen, bevor sie sich zum Beispiel in eine API-Referenz oder einen langen Leitfaden zur Fehlerbehebung bewegen.
• Verwenden Sie die Seite für Abschnitts-Landingpages, die Einführungsinhalte benötigen, zusammen mit Kindartikeln, zum Beispiel eine "Starting Start"-Seite, die den Abschnitt erklärt und auf Kindartikel verlinkt.
• Nutze GitHub nur, wenn deine Dokumentation aktiv in einem Repository gepflegt wird und du automatische Synchronisation brauchst, nicht für einmalige Importe.
• Vermeiden Sie häufige Typwechsel bei stark frequentierten Kategorien. Die Konvertierung in Page lässt die Kategorie im Entwurfszustand, was zu defekten Links führen kann, bis sie veröffentlicht werden.

FAQ