So fügen Sie Dokumentation in WordPress hinzu (Schritt für Schritt)

Die Erstellung einer umfassenden Dokumentation auf Ihrer WordPress-Website ist unerlässlich, wenn Sie Ihre Benutzer effektiv anleiten und unterstützen möchten. Eine ordnungsgemäße Dokumentation kann ihnen helfen, Ihre Produkte oder Dienstleistungen zu verstehen, was zu einer besseren Gesamterfahrung führt.

In den letzten 16 Jahren haben wir mehrere Websites aufgebaut, auf denen wir Plugins und Kurse verkaufen und immer detaillierte Dokumentationen hinzufügen, um unsere Benutzer zu unterstützen. Wir decken alles ab, vom Installationsprozess und Anleitungen zu Funktionen bis hin zu Details zu Add-ons, mit dem Ziel, die Fehlerbehebung zu erleichtern.

Wir haben festgestellt, dass dies Benutzern hilft, ihre eigenen Probleme zu lösen und Vertrauen in unsere Produkte aufzubauen, da sie sich sicher fühlen, wenn sie wissen, dass wir alle wichtigen Informationen klar und übersichtlich organisiert haben.

Deshalb empfehlen wir, Dokumentation hinzuzufügen, egal ob Sie ein produktorientiertes Unternehmen, eine Mitgliedschaftsseite oder eine Bildungsplattform betreiben.

In diesem Artikel zeigen wir Ihnen, wie Sie ganz einfach Schritt für Schritt Dokumentationen in WordPress hinzufügen. Unsere Anleitung ist sehr einfach zu befolgen und erfordert keine Programmierkenntnisse.

Warum Dokumentation in WordPress hinzufügen?

Dokumentation sind Inhalte auf Ihrer WordPress-Website, die Informationen zur Verwendung Ihrer Produkte/Dienstleistungen liefern, einschließlich ihrer Funktionen, neuen Veröffentlichungen, Add-ons und mehr.

WordPress-Dokumentation kann Anleitungen, Leitfäden, FAQs, Wissensdatenbanken und API-Dokumentation umfassen.

Zum Beispiel, wenn Sie einen Online-Shop haben, der Musik verkauft, können Sie eine Dokumentation erstellen, die beschreibt, wie man Musik herunterlädt, Lizenzen erneuert oder eine Playlist erstellt.

Das Hinzufügen von Dokumentation in WordPress kann die Benutzererfahrung verbessern, indem es Kunden erleichtert, verschiedene Produktfunktionen zu entdecken, die Ursachen ihrer Probleme zu finden und sie selbst zu beheben. Dies kann sogar die Anzahl der Support-Tickets für Ihre Website reduzieren.

Dokumentation kann auch Ihre SEO-Rankings verbessern, indem sie zusätzlichen Inhalt bereitstellt, den Google und andere Suchmaschinen indizieren und in den Suchergebnissen anzeigen können.

Nichtsdestotrotz wollen wir nun Schritt für Schritt sehen, wie Sie ganz einfach Dokumentationen in WordPress hinzufügen können.

Wie man Dokumentation in WordPress hinzufügt

Sie können Dokumentationen in WordPress ganz einfach mit dem Heroic KB Plugin hinzufügen.

Es ist das beste WordPress-Knowledge-Base-Plugin auf dem Markt, das Ihrer bestehenden Website eine durchsuchbare Wissensdatenbank hinzufügt. Es verfügt über eine AJAX-Suchfunktion, Drag & Drop-Inhaltsreihenfolge, Artikelanhänge und mehr.

Außerdem verfügt das Tool über integrierte Analysen und eine Funktion für Benutzerfeedback, mit der Sie Erkenntnisse sammeln können, um Ihre vorhandene Dokumentation zu verbessern.

Es verfügt sogar über eine Heroic AI Assistant-Funktion, mit der Sie ganz einfach einen benutzerdefinierten Chatbot zu Ihrer Website hinzufügen können. Der Chatbot wird direkt aus Ihrer Wissensdatenbank trainiert, sodass er genaue und personalisierte Antworten für Ihre Kunden liefern kann.

Schritt 1: Allgemeine Einstellungen von Heroic KB konfigurieren

Zuerst müssen Sie das Heroic KB Plugin installieren und aktivieren. Detaillierte Anweisungen finden Sie in unserer Schritt-für-Schritt-Anleitung, wie Sie ein WordPress-Plugin installieren.

Besuchen Sie nach der Aktivierung die Seite Heroic KB » Einstellungen in der WordPress-Admin-Seitenleiste und wechseln Sie zum Reiter „Lizenz und Updates“.

Geben Sie hier Ihren Plugin-Lizenzschlüssel ein und klicken Sie auf die Schaltfläche „Änderungen speichern“. Diese Informationen erhalten Sie von Ihrem Konto auf der Heroic KB-Website.

Nach dem Hinzufügen des Lizenzschlüssels wechseln Sie in der linken Spalte zum Reiter „Startseite & Allgemein“. Sie müssen die Dokumentations-Startseite aus dem Dropdown-Menü neben der Option „KB-Startseite“ auswählen.

Wenn Sie die Option „Wissensdatenbank-Archiv“ wählen, erstellt Heroic KB eine neue Seite für Ihre Dokumentation unter www.example.com/knowledge-base.

Wenn Sie Ihre Dokumentation jedoch zu einer bereits erstellten Seite hinzufügen möchten, können Sie diese Option aus dem Dropdown-Menü auswählen.

Als Nächstes können Sie auch den Header-Text eingeben, der oben auf Ihrer Dokumentationsseite angezeigt wird.

Sobald Sie das getan haben, aktivieren Sie einfach die Option „Breadcrumbs“, um sie zu aktivieren.

In einer Wissensdatenbank sind Breadcrumbs eine Art Navigationshilfe, die es Benutzern ermöglicht zu sehen, wie sie zur aktuellen Seite gelangt sind, und zu früheren Seiten zurückzukehren, wie zum Beispiel: Home » Produkte » Installation.

Als Nächstes können Sie auch die Anzahl der Spalten für Kategorien auswählen, die auf Ihrer Dokumentationsseite angezeigt werden sollen, aus dem Dropdown-Menü.

Überprüfen Sie dann die Option „KB-Kategorienanzahl anzeigen“, wenn Sie die Anzahl der für jede Kategorie geschriebenen Artikel anzeigen möchten.

Wählen Sie als Nächstes die Anzahl der Artikel aus, die unter jeder Kategorie auf der Dokumentations-Startseite angezeigt werden sollen, über das Dropdown-Menü „KB-Kategorie-Artikel“.

Dann können Sie die Kontrollkästchen „Leere Kategorien ausblenden“ und „Nicht kategorisierte Artikel ausblenden“ aktivieren. Auf diese Weise werden weder die aktuell leeren Kategorien noch die nicht kategorisierten Artikel auf Ihrer Dokumentations-Homepage angezeigt.

Danach können Sie den Zugriff auf Ihre WordPress-Dokumentation über das Dropdown-Menü „Zugriff einschränken“ auf nur für angemeldete Benutzer beschränken.

Wenn Sie fertig sind, klicken Sie einfach auf die Schaltfläche „Änderungen speichern“, um Ihre Einstellungen zu speichern.

Schritt 2: Kategorien, Tags und Artikel-Einstellungen konfigurieren

Wechseln Sie nun im linken Bereich zum Tab „Kategorien & Tags“. Hier können Sie auswählen, wie Ihre Kategorien und Tags sortiert werden sollen und wie viele Artikel für jede Taxonomie angezeigt werden sollen.

Sie können auch das Kontrollkästchen 'Artikel-Auszug' aktivieren, wenn Sie unter jedem Taxonomie-Archiv in Ihrer Dokumentation einen Artikel-Snippet anzeigen möchten.

Klicken Sie als Nächstes einfach auf die Schaltfläche „Änderungen speichern“ und wechseln Sie zum Reiter „Artikel“.

Von hier aus können Sie verschiedene Kontrollkästchen aktivieren, um einen Kommentarbereich unter Ihren Dokumentationsartikeln zu aktivieren, Autoren-Bios anzeigen oder andere verwandte Artikel unter jedem Tutorial anzeigen.

Nachdem Sie Ihre Wahl getroffen haben, klicken Sie einfach auf die Schaltfläche „Änderungen speichern“, um Ihre Einstellungen zu speichern.

Schritt 3: Einstellungen für Wissensdatenbank-Suche und Slug konfigurieren

Wechseln Sie nun zum Tab „Suche“ und aktivieren Sie das Kontrollkästchen „Suchfokus“, wenn die Maus des Benutzers automatisch auf dem Suchfeld der Dokumentation landen soll, wenn die Seite geladen wird.

Als Nächstes können Sie auch Platzhaltertext für das Suchfeld hinzufügen, Artikel-Auszüge in den Suchergebnissen anzeigen und das Plugin sogar aktivieren, um den Suchbegriff in den Ergebnissen hervorzuheben.

Sobald Sie dies getan haben, klicken Sie auf „Änderungen speichern“ und wechseln Sie zum Reiter „Slugs“.

Hier können Sie Slugs für die Artikel, Kategorien und Tags Ihrer Dokumentation hinzufügen.

Nachdem Sie Ihre Wahl getroffen haben, klicken Sie auf die Schaltfläche „Änderungen speichern“, um Ihre Einstellungen zu speichern.

Schritt 4: Einstellungen für Wissensdatenbank-Seitenleiste und Stil konfigurieren

Wechseln Sie als Nächstes zum Reiter „Seitenleisten“, um ein Layout für die Seitenleisten auf Ihren Dokumentationsseiten auszuwählen.

Sie können verschiedene Positionen für die Home-Seitenleiste, die Kategorie-Seitenleiste und die Artikel-Seitenleiste auswählen. Sie können sogar die Option 'Sticky Article Sidebar?' aktivieren, um eine Sticky-Seitenleiste für Seiten zu aktivieren.

Sobald Sie dies getan haben, klicken Sie auf „Änderungen speichern“ und wechseln Sie zum Tab „Stile“.

Von hier aus können Sie Ihre Dokumentationsbreite, Linkfarbe, Kopfzeilenstil und Textfarbe nach Belieben auswählen.

Klicken Sie dann einfach auf die Schaltfläche „Änderungen speichern“.

Schritt 5: Artikel-Feedback und E-Mail-Einstellungen einrichten

Als Nächstes müssen Sie zum Tab 'Artikel-Feedback' wechseln und die Option 'Feedback aktivieren' auswählen, um Benutzern zu ermöglichen, Ihre Artikel zu bewerten.

Sie können sogar ein Upvote/Downvote-System für Ihre WordPress-Dokumentation hinzufügen, indem Sie diese Kästchen ankreuzen. Dies ermöglicht es den Benutzern, Ihnen mitzuteilen, ob Ihre Dokumentation bei der Lösung ihrer Probleme im Frontend hilft.

Klicken Sie nun auf die Schaltfläche „Änderungen speichern“, um Ihre Einstellungen zu speichern.

Wechseln Sie nun im linken Menü zum Tab „E-Mail-Berichte“ und aktivieren Sie die Option „E-Mail-Berichte aktivieren?“, wenn Heroic KB Ihnen wöchentliche Berichte über Ihre Dokumentation senden soll.

Dieser Bericht enthält die Gesamtzahl der Aufrufe und die durchschnittliche Bewertung Ihrer Dokumentationsartikel und zeigt sogar eine Liste der Top- und am besten bewerteten Artikel für diese Woche an.

Sobald Sie dies getan haben, fügen Sie Ihre Admin-E-Mail-Adresse in das Feld „Berichtsempfänger“ ein. Sie können auch mehrere E-Mail-Adressen hinzufügen, wenn Sie möchten.

Klicken Sie anschließend auf die Schaltfläche „Änderungen speichern“, um Ihre Einstellungen zu speichern.

Jetzt, da Sie alle Einstellungen für das Heroic KB-Plugin konfiguriert haben, ist es an der Zeit, mit der Erstellung von Dokumentationen für Ihre Website zu beginnen.

Schritt 6: Dokumentation für Ihre WordPress-Website erstellen

Sie können Anleitungen, Wissensdatenbanken, Guides und FAQs für Ihre Dokumentation erstellen.

Um mit der Erstellung eines neuen Dokuments zu beginnen, besuchen Sie die Seite Heroic KB » Neuen Artikel hinzufügen im WordPress-Dashboard.

Dies öffnet den WordPress-Inhaltseditor, wo Sie eine Überschrift für Ihren Dokumentationsartikel hinzufügen und mit dem Schreiben des Inhalts beginnen können. Sie können auch auf die Schaltfläche „Block hinzufügen“ (+) in der oberen linken Ecke klicken, um verschiedene Blöcke zu Ihrem Inhalt hinzuzufügen.

Sobald Sie den Artikel für die Dokumentation geschrieben haben, müssen Sie im Block-Panel den Reiter „Kategorien“ erweitern und auf den Link „Neue Artikelkategorie hinzufügen“ klicken.

Erstellen Sie als Nächstes einfach eine Kategorie für den Artikel, den Sie schreiben.

Erweitern Sie danach den Abschnitt 'Tags' im Block-Panel und fügen Sie so viele Tags hinzu, wie Sie für Ihren Dokumentationsartikel wünschen.

Sie können sogar einen Auszug für den Artikel hinzufügen, indem Sie den Tab „Auszug“ erweitern.

Erweitern Sie als Nächstes den Tab „Diskussion“ und deaktivieren Sie die Option „Kommentare zulassen“, wenn Sie Kommentare für diesen Artikel deaktivieren möchten. Wenn Sie Benutzern das Hinzufügen von Kommentaren ermöglichen möchten, können Sie diese Einstellung so belassen, wie sie ist.

Sie können Ihren Artikeln in der Dokumentation auch Anhänge hinzufügen. Scrollen Sie dazu im Block-Editor nach unten zum Abschnitt „Artikeloptionen“ und klicken Sie auf die Schaltfläche „Dateien hinzufügen oder hochladen“.

Dies öffnet die Mediathek, aus der Sie jede gewünschte Anhangdatei hinzufügen können.

Aktivieren Sie als Nächstes das Kontrollkästchen 'Anhänge in neuem Fenster', wenn die Anhänge im Artikel beim Anklicken in einem neuen Fenster geöffnet werden sollen.

Sie können die Upvote/Downvote-Funktion auch für bestimmte Artikel deaktivieren, indem Sie zum Abschnitt „Abstimmungsoptionen“ scrollen.

Hier, aktivieren Sie die Option „Abstimmungen deaktivieren“, um das System für Upvotes/Downvotes für diesen speziellen Artikel zu deaktivieren.

Klicken Sie abschließend oben auf die Schaltfläche „Veröffentlichen“, um Ihren Artikel als Dokumentation zu veröffentlichen.

Wiederholen Sie dann den Vorgang, um mehrere Einträge für Ihre Dokumentation unter verschiedenen Kategorien hinzuzufügen.

Sobald Sie dies getan haben, können Sie die Dokumentation einfach anzeigen, indem Sie die Seite www.example.com/knowledge-base besuchen, oder Sie können die benutzerdefinierte Seite besuchen, die Sie für Ihre Dokumentation ausgewählt haben.

Schritt 7: Reihenfolge der Artikel und Kategorien Ihrer Dokumentation ändern

Mit Heroic KB können Sie auch die Reihenfolge der Artikel ändern, die in Ihrer WordPress-Wissensdatenbank angezeigt werden. Besuchen Sie dazu die Seite Artikelreihenfolge von Heroic KB im WordPress-Dashboard.

Wählen Sie hier die Kategorie aus, für die Sie die Artikelreihenfolge ändern möchten. Ziehen Sie dann einfach die Artikel per Drag & Drop, um sie nach Ihren Wünschen neu anzuordnen.

Wenn Sie fertig sind, denken Sie daran, auf die Schaltfläche „Reihenfolge speichern“ zu klicken, um Ihre Einstellungen zu speichern.

Um die Reihenfolge der Kategorien auf Ihrer Dokumentationsseite zu ändern, besuchen Sie die Seite Heroic KB » Kategorie-Reihenfolge in der WordPress-Admin-Seitenleiste.

Dort angekommen können Sie die Reihenfolge der Kategorien durch Ziehen und Ablegen neu anordnen. Nachdem Sie die Änderungen vorgenommen haben, klicken Sie auf die Schaltfläche „Reihenfolge speichern“, um Ihre Einstellungen zu speichern.

Sie haben nun erfolgreich Dokumentation für Ihre Website erstellt und deren Kategorie- und Artikelreihenfolge geändert.

Bonus: Fügen Sie Ihrer WordPress-Website einen FAQ-Bereich hinzu

Das Hinzufügen von WordPress-Dokumentation ist eine großartige Möglichkeit, Ihren Benutzern zu helfen, die benötigten Informationen zu finden. Sie können auch FAQs (häufig gestellte Fragen) zusammen mit Ihren Blogbeiträgen hinzufügen, um häufig gestellte Fragen zu Ihren Inhalten zu beantworten.

Dies kann das Benutzerengagement auf Ihrem WordPress-Blog erhöhen und Vertrauen und Glaubwürdigkeit bei Ihren Benutzern aufbauen, indem Sie ihnen zeigen, dass Sie ihre Fragen und Bedenken verstehen.

Außerdem können FAQs Ihre SEO-Rankings verbessern, da Sie damit Long-Tail-Keywords verwenden können, nach denen Benutzer häufig über Suchmaschinen suchen.

Sie können Ihrer Website ganz einfach FAQs hinzufügen mit All in One SEO (AIOSEO). Es ist das beste WordPress SEO-Plugin auf dem Markt, mit dem Sie Ihre Website einfach optimieren können, um die Suchmaschinenrankings zu verbessern.

AIOSEO verfügt sogar über einen benutzerfreundlichen FAQ-Block, der direkt zum Block-Editor hinzugefügt werden kann, wo Sie Fragen und Antworten für Ihren FAQ-Bereich eingeben können.

Das Plugin ermöglicht es Ihnen auch, Ihren FAQ-Bereich über das Block-Panel anzupassen, einschließlich Textfarbe, Hintergrundfarbe, Typografie und Titel-Wrapper, was AIOSEO zum besten WordPress FAQ-Plugin auf dem Markt macht.

Außerdem wird das Plugin mit FAQ-Schema-Markup geliefert, das Ihre Website-Rankings und die organische Klickrate verbessern kann, indem Ihre häufig gestellten Fragen direkt in den Google-Suchergebnissen angezeigt werden.

Für detailliertere Anweisungen siehe unser Tutorial zum Hinzufügen eines Abschnitts mit häufig gestellten Fragen (FAQs) in WordPress.

Wir hoffen, dieser Artikel hat Ihnen geholfen zu lernen, wie Sie Dokumentationen in WordPress hinzufügen. Möglicherweise möchten Sie auch unseren Leitfaden für Anfänger zum Thema wie Sie virtuelle Assistenten für Ihre WordPress-Website einstellen und unsere Expertenauswahl für die beste technische Dokumentationssoftware für WordPress ansehen.

Wenn Ihnen dieser Artikel gefallen hat, abonnieren Sie bitte unseren YouTube-Kanal für WordPress-Video-Tutorials. Sie finden uns auch auf Twitter und Facebook.