Wie man Dokumentation in WordPress hinzufügt (Schritt für Schritt)

Die Erstellung einer ausführlichen Dokumentation für Ihre WordPress-Website ist unerlässlich, wenn Sie Ihre Nutzer effektiv anleiten und unterstützen wollen. Eine ordnungsgemäße Dokumentation kann ihnen helfen zu verstehen, wie sie Ihre Produkte oder Dienstleistungen nutzen können, 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 wir fügen immer eine ausführliche Dokumentation hinzu, um unsere Nutzer zu unterstützen. Wir decken alles ab, vom Installationsprozess über Anleitungen zu Funktionen bis hin zu Details zu Addons, um die Fehlersuche zu erleichtern.

Wir haben festgestellt, dass dies den Nutzern hilft, ihre eigenen Probleme zu lösen, und das Vertrauen in unsere Produkte stärkt, da sie sich sicher fühlen, dass wir alle wichtigen Informationen übersichtlich dargestellt haben.

Deshalb empfehlen wir, eine Dokumentation hinzuzufügen, unabhängig davon, ob Sie ein produktorientiertes Unternehmen, eine Mitgliedschaftsseite oder eine Bildungsplattform betreiben.

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

Warum Dokumentation in WordPress hinzufügen?

Die Dokumentation ist ein Inhalt auf Ihrer WordPress-Website, der Informationen über die Verwendung Ihrer Produkte/Dienstleistungen, einschließlich ihrer Funktionen, neuer Versionen, Add-Ons und mehr enthält.

Die WordPress-Dokumentation kann Anleitungen, Handbücher, FAQs, Wissensdatenbanken und API-Dokumentation umfassen.

Wenn Sie z. B. einen Online-Shop haben , der Musik verkauft, können Sie eine Dokumentation erstellen, in der beschrieben wird, wie man die Musik herunterlädt, Lizenzen erneuert oder eine Wiedergabeliste erstellt.

Das Hinzufügen von Dokumentationen in WordPress kann die Benutzererfahrung verbessern, indem es den Benutzern erleichtert wird, verschiedene Funktionen des Produkts zu entdecken, die Ursachen für ihre Probleme zu finden und sie selbst zu beheben. Dies kann sogar die Anzahl der Support-Tickets für Ihre Website reduzieren.

Die Dokumentation kann auch Ihre SEO-Rangliste verbessern, indem sie zusätzliche Inhalte liefert, die von Google und anderen Suchmaschinen indiziert und in den Suchergebnissen angezeigt werden können.

Sehen wir uns also an, wie man in WordPress Schritt für Schritt eine Dokumentation hinzufügen kann.

Hinzufügen von Dokumentation in WordPress

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

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

Außerdem verfügt das Tool über integrierte Analysefunktionen und eine Funktion für Benutzer-Feedback, mit der Sie Erkenntnisse zur Verbesserung Ihrer bestehenden Dokumentation sammeln können.

Es verfügt sogar über eine Heroic AI Assistant-Funktion, mit der Sie Ihrer Website ganz einfach einen benutzerdefinierten Chatbot hinzufügen können. Der Chatbot wird direkt von Ihrer Wissensdatenbank trainiert, sodass er Ihren Kunden präzise und personalisierte Antworten geben kann.

Schritt 1: Allgemeine Einstellungen von Heroic KB konfigurieren

Zunächst müssen Sie das Heroic KB-Plugin installieren und aktivieren. Eine ausführliche Anleitung finden Sie in unserer Schritt-für-Schritt-Anleitung zur Installation eines WordPress-Plugins.

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

Geben Sie hier den Lizenzschlüssel für Ihr Plugin ein und klicken Sie auf die Schaltfläche „Änderungen speichern“. Sie können diese Informationen über Ihr Konto auf der Heroic KB-Website abrufen.

Nachdem Sie den Lizenzschlüssel hinzugefügt haben, wechseln Sie in der linken Spalte zur Registerkarte „Home & Allgemein“. Wählen Sie die Homepage der Dokumentation aus dem Dropdown-Menü neben der Option „KB-Homepage“.

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

Wenn Sie Ihre Dokumentation jedoch auf 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 Kopfzeilentext eingeben, der oben auf Ihrer Dokumentationsseite angezeigt werden soll.

Wenn Sie das getan haben, aktivieren Sie die Option „Brotkrümel“, um sie zu aktivieren.

In einer Wissensdatenbank sind Breadcrumbs eine Art Navigationshilfe, die es den Nutzern ermöglicht, zu sehen, wie sie auf die aktuelle Seite gelangt sind, und auf diese Weise zu den vorherigen Seiten zurück zu navigieren: Startseite “ Produkte “ Installation.

Anschließend können Sie im Dropdown-Menü die Anzahl der Kategorienspalten auswählen, die auf Ihrer Dokumentationsseite angezeigt werden sollen.

Aktivieren Sie dann die Option „Zählungen der KB-Kategorien anzeigen“, wenn Sie die Anzahl der für jede Kategorie geschriebenen Artikel anzeigen möchten.

Wählen Sie anschließend im Dropdown-Menü „KB-Kategorie Artikel“ die Anzahl der Artikel aus, die unter jeder Kategorie auf der Homepage der Dokumentation angezeigt werden sollen.

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

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

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

Schritt 2: Konfigurieren Sie Kategorien, Tags und Artikeleinstellungen

Wechseln Sie nun in der linken Spalte zur Registerkarte „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 Kästchen „Artikelauszug“ ankreuzen, wenn Sie unter jedem Taxonomie-Archiv in Ihrer Dokumentation einen Artikelausschnitt anzeigen möchten.

Klicken Sie dann einfach auf die Schaltfläche „Änderungen speichern“ und wechseln Sie zur Registerkarte „Artikel“.

Von hier aus können Sie verschiedene Kästchen ankreuzen, um einen Kommentarbereich unter Ihren Dokumentationsartikeln zu aktivieren, Autorenbiografien anzuzeigen oder andere verwandte Artikel unter jedem Tutorial anzuzeigen.

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

Schritt 3: Wissensdatenbank-Suche und Slug-Einstellungen einrichten

Wechseln Sie nun zur Registerkarte „Suche“ und aktivieren Sie das Kontrollkästchen „Suchfokus“, wenn Sie möchten, dass die Maus des Benutzers beim Laden der Seite automatisch auf dem Suchfeld für die Dokumentation landet.

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

Klicken Sie anschließend auf „Änderungen speichern“ und wechseln Sie zur Registerkarte „Stecklinge“.

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

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

Schritt 4: Konfigurieren der Seitenleiste der Wissensdatenbank und der Stileinstellungen

Wechseln Sie dann zur Registerkarte „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 Sidebar für Seiten zu aktivieren.

Klicken Sie anschließend auf „Änderungen speichern“ und wechseln Sie zur Registerkarte „Stile“.

Von hier aus können Sie die Breite der Dokumentation, die Farbe der Links, die Gestaltung der Kopfzeile und die Textfarbe nach Ihren Wünschen 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 auf die Registerkarte „Artikel-Feedback“ wechseln und die Option „Feedback aktivieren“ ankreuzen, damit die Nutzer Ihre Artikel bewerten können.

Sie können sogar ein Upvote/Downvote-System für Ihre WordPress-Dokumentation einrichten, indem Sie diese Boxen ankreuzen. So können Benutzer Ihnen mitteilen, 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 zur Registerkarte „E-Mail-Berichte“ in der linken Spalte und aktivieren Sie die Option „E-Mail-Berichte aktivieren?“, wenn Sie möchten, dass Heroic KB Ihnen wöchentlich Berichte über Ihre Dokumentation sendet.

Dieser Bericht enthält die Gesamtzahl der Aufrufe und die durchschnittliche Bewertung Ihrer Dokumentationsartikel und zeigt sogar eine Liste der am besten und am höchsten bewerteten Artikel der betreffenden Woche an.

Fügen Sie anschließend Ihre Administrator-E-Mail-Adresse in das Feld „Berichtsempfänger“ ein. Sie können sogar 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.

Nachdem Sie nun alle Einstellungen für das Heroic KB-Plugin vorgenommen haben, können Sie mit der Erstellung der Dokumentation für Ihre Website beginnen.

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

Sie können Anleitungsartikel, Wissensdatenbanken, Leitfäden und FAQs für Ihre Dokumentation erstellen.

Um ein neues Dokument zu erstellen, besuchen Sie die Seite Heroic KB “ Neuen Artikel hinzufügen im WordPress-Dashboard.

Dadurch wird der WordPress-Inhaltseditor geöffnet , in dem 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 „+“ 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 die Registerkarte „Kategorien“ im Block-Panel erweitern und auf den Link „Neue Artikelkategorie hinzufügen“ klicken.

Als Nächstes erstellen Sie einfach eine Kategorie für den Artikel, den Sie schreiben.

Erweitern Sie anschließend den Abschnitt „Tags“ im Blockbedienfeld und fügen Sie so viele Tags wie gewünscht für Ihren Dokumentationsartikel hinzu.

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

Erweitern Sie dann die Registerkarte „Diskussion“ und deaktivieren Sie die Option „Kommentare zulassen“, wenn Sie Kommentare für diesen Artikel deaktivieren möchten. Wenn Sie möchten, dass Benutzer Kommentare hinzufügen, können Sie diese Einstellung beibehalten.

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

Dadurch wird die Mediathek geöffnet, aus der Sie beliebige Anhänge hinzufügen können.

Aktivieren Sie als Nächstes das Kontrollkästchen „Anhänge in neuem Fenster“, wenn Sie möchten, dass die Anhänge des Artikels beim Anklicken in einem neuen Fenster geöffnet werden.

Wenn Sie möchten, können Sie die Funktion zum Hoch- und Runterstimmen für bestimmte Artikel auch deaktivieren, indem Sie zum Abschnitt „Abstimmungsoptionen“ hinunter scrollen.

Aktivieren Sie hier die Option „Abstimmung deaktivieren“, um das System zur Aufwärts-/Abwärtsbewertung für diesen bestimmten Artikel zu deaktivieren.

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

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

Wenn Sie dies getan haben, können Sie die Dokumentation ganz einfach auf der Seite www.example.com/knowledge-base oder auf der benutzerdefinierten Seite, die Sie für Ihre Dokumentation ausgewählt haben, aufrufen.

Schritt 7: Ändern Sie die Reihenfolge der Artikel und Kategorien in Ihrer Dokumentation

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

Wählen Sie hier die Kategorie aus, für die Sie die Reihenfolge der Artikel ändern möchten. Ziehen Sie die Artikel dann einfach per Drag-and-drop, um sie nach Ihren Wünschen neu anzuordnen.

Vergessen Sie nicht, auf die Schaltfläche „Bestellung speichern“ zu klicken, um Ihre Einstellungen zu speichern.

Um die Reihenfolge der auf Ihrer Dokumentationsseite angezeigten Kategorien zu ändern, besuchen Sie die Seite Heroic KB “ Category Ordering in der WordPress-Admin-Seitenleiste.

Dort 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 eine Dokumentation für Ihre Website erstellt und die Reihenfolge der Kategorien und Artikel geändert.

Bonus: Fügen Sie einen FAQ-Abschnitt zu Ihrer WordPress-Website 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) zu Ihren Blogbeiträgen hinzufügen, um häufig gestellte Fragen zu Ihrem Inhalt zu beantworten.

Dies kann das Engagement der Nutzer in Ihrem WordPress-Blog erhöhen und Vertrauen und Glaubwürdigkeit bei Ihren Nutzern aufbauen, indem Sie sie wissen lassen, dass Sie ihre Fragen und Sorgen verstehen.

Außerdem können FAQs Ihr SEO-Ranking verbessern, da Sie Long-Tail-Keywords verwenden können, nach denen Benutzer häufig in Suchmaschinen suchen.

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

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

Das Plugin ermöglicht es Ihnen auch, Ihre FAQ-Sektion über das Block-Panel anzupassen, einschließlich der Textfarbe, Hintergrundfarbe, Typografie und des Titelumbruchs, was AIOSEO zum besten WordPress FAQ-Plugin auf dem Markt macht.

Außerdem enthält das Plugin eine FAQ-Schemaauszeichnung, die das Ranking Ihrer Website und die organische Klickrate steigern kann, indem sie Ihre häufig gestellten Fragen direkt in den Google-Suchergebnissen erscheinen lässt.

Ausführlichere Anweisungen finden Sie in unserem Tutorial über das Hinzufügen eines Abschnitts für häufig gestellte Fragen in WordPress.

Wir hoffen, dass dieser Artikel Ihnen geholfen hat, zu lernen, wie Sie Dokumentation in WordPress hinzufügen können. Vielleicht interessieren Sie sich auch für unseren Leitfaden für Einsteiger, wie Sie virtuelle Assistenten für Ihre WordPress-Website einstellen können, und für unsere Expertenauswahl der besten Software für technische Dokumentation für WordPress.

Wenn Ihnen dieser Artikel gefallen hat, dann abonnieren Sie bitte unseren YouTube-Kanal für WordPress-Videotutorials. Sie können uns auch auf Twitter und Facebook finden.