Entwickler des Betterdocs WordPress-Dokumentations-Plugins

Ultimativer Leitfaden für eine bessere WordPress-Dokumentation für jeden Plugin-Entwickler

Wenn Sie ein Entwickler sind, der Plugins für WordPress erstellt, richten Sie a ein WordPress-Dokumentation oder eine Wissensbasis sollte ein wesentlicher Bestandteil Ihrer Kundenunterstützungsstrategie sein. Schließlich ist es für Sie möglicherweise sehr einfach, Ihr eigenes Plugin zu verwenden, aber Ihre potenziellen Kunden oder Endbenutzer benötigen möglicherweise eine geeignete Anleitung, um wirklich zu verstehen, wie Ihr Plugin funktioniert.

Entwickler des Betterdocs WordPress-Dokumentations-Plugins

Aus diesem Grund sollten Sie auf jeden Fall Zeit in Betracht ziehen, um eine ordnungsgemäße, informative und nützliche Einrichtung einzurichten Plugin-Dokumentation für Ihre Produktbenutzer. Ohne Angebot Plugin-Dokumentation Für Ihre Benutzer wird es für Sie und Ihr Team schwierig sein, Erfolg zu haben, da Sie immer wieder Tonnen von Support-Tickets erhalten.

Stellen Sie sich vor, wie Sie sich fühlen würden, wenn Sie eine brandneue Waschmaschine kaufen würden, aber keine Ahnung hätten, wie Sie sie zum Laufen bringen könnten, da sie ohne Anweisungen oder Bedienungsanleitung geliefert wurde. Sie könnten den Kundendienst anrufen, müssten aber lange in der Schlange stehen, während der Kundendienst die Fragen aller anderen beantwortet.

Also, wenn Sie ein sind WordPress Plugin Entwickler Wenn Sie möchten, dass Ihre Kunden gute Erfahrungen mit Ihren Produkten machen, sollten Sie eine einfallsreiche WordPress-Dokumentation einrichten, die für sie einfach zu verwenden und zu verstehen ist.

Über die Bedeutung der Dokumentation für WordPress-Plugins sprechen, Vova Feldman, der Gründer von Freemius geteilt: 

"With proper documentation, you & your support team can work more efficiently by referring users to documented topics instead of writing them over and over again. It improves the UX for users that are comfortable finding solutions in a self-serve approach which naturally reduces the support load."

Vova Feldman - ​Founder & CEO, Freemius Tweet

Inhaltsverzeichnis

Alles, was Sie über die WordPress-Dokumentation wissen müssen

Die Haupt Zweck der Dokumentation is to provide your users with detailed information about how they can use your product. 

It is much more comprehensive than a simple FAQ (Häufig gestellte Fragen) Seite und sollte auch für Personen, die keine technischen Kenntnisse über Ihr Produkt haben, leicht zu lesen und zu verstehen sein.

To sum it up in a nutshell, your WordPress documentation acts as the user manual for your product and should make your end-users feel like an expert when they are using your plugins. 

Stellen Sie sicher, dass Ihre Plugin-Dokumentation so viele Fragen wie möglich beantwortet, von der Unterweisung der Benutzer in der Installation und Aktivierung Ihres Plugins über die Konfiguration der Einstellungen bis hin zur Optimierung mit verschiedenen Funktionen.

Lassen Sie uns einen Blick darauf werfen, warum dies für jeden Plugin-Entwickler so wichtig ist. Im Folgenden geben wir Ihnen einen kurzen Überblick darüber, wie Sie von einer Plugin-Dokumentation profitieren können.

👉Assist Non-Technical Users To Understand Your WordPress Plugin: Während einige Ihrer Endbenutzer möglicherweise über technisches Wissen verfügen, die meisten Benutzer von WordPress haben in der Regel einen nicht technischen Hintergrund. Dies bedeutet, dass Sie eine Dokumentation für Ihr WordPress-Plugin anbieten müssen, die für nicht technische Benutzer leicht verständlich ist.

👉Enhance User Experience With A Detailed WordPress Documentation: Wenn Ihre Benutzer herausfinden können, wie Sie Ihr WordPress-Plugin verwenden, indem Sie einfach die von Ihnen bereitgestellte Plugin-Dokumentation durchgehen, fühlen sie sich mit Ihrem WordPress-Plugin befähigt und zufrieden.

👉Reduce Support Tickets & Workload On Your Team: Eine gute WordPress-Dokumentation kann Ihnen dabei helfen, Support-Tickets und die Arbeitsbelastung Ihres Support-Teams zu reduzieren. Wenn Ihre Endbenutzer die meisten ihrer Probleme durch Lesen Ihrer Plugin-Dokumentation lösen können, müssen sie sich nicht an Ihr Support-Team wenden.

👉Safeguard Yourself From Negative Reviews: Ohne eine ordnungsgemäße WordPress-Dokumentation verstehen Ihre Benutzer möglicherweise nicht, wie Ihr Plugin funktioniert. Dies führt sehr wahrscheinlich dazu, dass sich Ihre Benutzer so frustriert fühlen, dass sie möglicherweise negative Bewertungen zu Ihren Plugins abgeben. Um sich vor negativen Bewertungen zu schützen, bieten Sie eine inhaltsreiche WordPress-Dokumentation an.

👉SEO Benefits of Documentation: Eine ordnungsgemäße Dokumentation hilft Ihnen zwar dabei, den Kunden alle Informationen zur Verfügung zu stellen, die sie benötigen. Es ist jedoch unwirksam, wenn Kunden nicht herausfinden können, wo sie darauf zugreifen können. Hier kann die Wissensdatenbank eine vergleichsweise einfache Möglichkeit sein, ganz oben auf der Google-Suche zu stehen, wenn Sie Ihre Dokumentation ordnungsgemäß für den Suchmaschinenverkehr optimiert haben.

Der Inhalt ist einer der vier wichtigsten Ranking-Faktoren für den SEO-Algorithmus von Google. Die Dokumentation ist eine der Inhaltsquellen für Ihre Website, da sie mit den richtigen Optimierungen eher auf den Top-Seiten rangiert.

✅ Anleitung zum Einrichten einer einfallsreichen WordPress-Dokumentation

Um eine nützliche, inhaltsreiche WordPress-Dokumentation einzurichten, müssen Sie einige grundlegende Richtlinien befolgen. Wir werden sie uns jetzt ansehen.

Verwenden Sie eine einfache Sprache für Ihre Plugin-Dokumentation

Denken Sie daran, dass der Zweck einer WordPress-Dokumentation darin besteht, Benutzern das Verständnis für die Verwendung Ihres Plugins zu erleichtern ohne needing technical expertise. 

Avoid using technical jargons as users who do not have technical knowledge will not be familiar with those terms.

Stellen Sie eine einfache Lesbarkeit für Ihre Benutzer sicher

Eine informative und einfallsreiche WordPress-Dokumentation enthält wahrscheinlich viele Inhalte. Verwenden Sie kurze Absätze, Bilder, Listen, Aufzählungszeichen, Inhaltsverzeichnisse und vieles mehr, damit Ihre Benutzer den gesamten Inhalt der Plugin-Dokumentation schnell lesen können. All dies erleichtert das Lesen Ihrer WordPress-Dokumentation.

Befolgen Sie eine geeignete Struktur für Ihre WordPress-Dokumentation

Eine effektive und nützliche WordPress-Dokumentation hat eine ordnungsgemäße Struktur. Dies bedeutet, dass der gesamte Inhalt Ihrer Plugin-Dokumentation sequentiellen, schrittweisen Anweisungen folgt.

Beispielsweise müssen alle WordPress-Plugins nach der Installation aktiviert werden. Wenn Sie den Schritt zum Aktivieren des Plugins überspringen, verstehen viele Benutzer möglicherweise nicht, warum Ihr Plugin für sie nicht funktioniert. Stellen Sie daher beim Schreiben Ihrer Plugin-Dokumentation sicher, dass Sie eine ordnungsgemäße, sequentielle Struktur einhalten, die für Ihre Endbenutzer sinnvoll ist.

Um eine bessere Vorstellung davon zu bekommen, wie eine hochwertige WordPress-Plugin-Dokumentation aussieht, lesen Sie diese Dokumentationsseiten, die für einige beliebte WordPress-Plugins erstellt wurden.

Organisieren Ihre Plugin-Dokumentation mit den richtigen Kategorien und Tags

Dies ist eine sehr wichtige Regel, die Sie beim Schreiben Ihrer Plugin-Dokumentation beachten sollten. Verwenden Sie immer richtige Kategorien und Tags um den Inhalt Ihrer WordPress-Dokumentation zu organisieren.

Das ist besonders wichtig Wenn Ihr Plugin über unzählige Funktionen verfügt, die Ihren Benutzern einzigartige Vorteile bieten. Dies erleichtert Benutzern das Auffinden ihrer relevanten Inhalte, wenn sie sich auf Ihrer Dokumentationshomepage befinden.

Aktualisieren und verbessern Sie die WordPress-Dokumentation regelmäßig

Jedes Mal, wenn Sie Ihr Plugin aktualisieren und verbessern, müssen Sie auch Ihre WordPress-Dokumentation aktualisieren, um sicherzustellen, dass die Informationen für Ihre Endbenutzer verwendet werden können. Andernfalls sind Ihre Benutzer verwirrt und frustriert, da sie die Plugin-Dokumentation nicht verstehen können.

Wenn Sie diese Richtlinien befolgen, können Sie eine hochwertige WordPress-Dokumentation erstellen, die für Ihre Benutzer relevant und inhaltsreich ist.  

🚀Create WordPress Documentation With BetterDocs: The Most Powerful Knowledge Base Solution

Nachdem Sie nun wissen, wie wichtig eine Plugin-Dokumentation ist und welche Richtlinien Sie befolgen müssen, fragen Sie sich möglicherweise Wie Genau können Sie Ihre eigene informative, inhaltsreiche WordPress-Dokumentation erstellen. 

Die fortschrittlichste Lösung zum Erstellen einer hochwertigen WordPress-Dokumentation ist BetterDocs.

BetterDocs ist das leistungsstärkste Dokumentations-Plugin, da es Ihnen dramatisch hilft Verkürzung der Zeit und Support-Tickets durch Erstellen einer schönen, durchsuchbaren WordPress-Dokumentation. Es wird dir gebracht von WPDeveloper, the WordPress product company that serving more than Über 700.000 WordPress-Benutzer from 180+ countries. It’s the same team behind Essential Addons für Elementor, NotificationX und mehr.

🔝 Key Features Of BetterDocs That Help You Create Better WordPress Documentation

There are several special features that make BetterDocs stand out among all other similar plugins. From a collection of beautiful, vorgefertigte Vorlagen, zu einem einfach zu bedienenden eingebauter Customizer, BetterDocs has everything you could need to create an attractive, organized documentation page in a matter of minutes. These features include:

✔️ A collection of premade, ready-to-use template designs 
✔️ A built-in Customizer zum Stylen Ihre Dokumentationsseiten
✔️ Automatically create sticky Inhaltsverzeichnis zur einfacheren Navigation

✔️ Advanced Live-Suche um relevante Inhalte schnell zu finden
✔️ Keep track of performance with Analytics & Report 
✔️ Sofortige Antworten ChatBot für verbesserte Benutzererfahrung 
✔️ SEO friendly Dokumentation mit dem richtigen Schema-Markup

🔥How To Use BetterDocs To Quickly Create Your WordPress Documentation

In diesem Abschnitt erfahren Sie, wie Sie mit BetterDocs schnell Ihre WordPress-Dokumentation erstellen. Wir beginnen mit den Grundlagen, wie zum Beispiel der Installation des BetterDocs-Plugins für WordPress, und zeigen Ihnen dann, wie Sie alle zuvor erwähnten coolen Funktionen zum Erstellen Ihrer Plugin-Dokumentation verwenden können.

Installieren und Aktivieren des BetterDocs-Plugins für WordPress

Das allererste, was Sie tun müssen, ist, das BetterDocs-Plugin für WordPress zu finden, indem Sie zu navigieren wp-admin -> Plugins -> Neu hinzufügen von Ihrem WordPress Dashboard. Dann müssen Sie 'BetterDocs' in das Suchfeld schreiben.

Sobald Sie das Plugin gefunden haben, einfach installieren und aktivieren es.

Konfigurieren Sie die Dokumentationshomepage und die einzelne Seite mit BetterDocs

Der nächste Schritt nach der Installation und Aktivierung von BetterDocs ist zu Konfigurieren Sie Ihre Dokumentationshomepage.

Dies ist sehr einfach zu tun. Standardmäßig verfügt BetterDocs über eine eigene Dokumentationshomepage, die Sie nach Belieben anpassen können. Wenn Sie jedoch Ihr eigenes Seitenlayout zuweisen möchten, können Sie dies tun, indem Sie die Standardhomepage deaktivieren und Funktionscodes oder Widgets für den Seitenersteller verwenden.

Navigieren Sie zu, um die mit BetterDocs gelieferte Standardhomepage zu konfigurieren und anzupassen BetterDocs -> Einstellungen -> Layout. Wählen Sie die Anzahl der Spalten aus, aktivieren oder deaktivieren Sie die Live-Suche und das Mauerwerkslayout, die Anzahl der Beiträge und vieles mehr.

Wenn Sie die einzelnen Dokumentationsseiten konfigurieren möchten, müssen Sie nur die auswählen "Single Doc" Tab, während Sie in der 'Layout' Klicken Sie auf die Registerkarte, bis Sie die Option "Einzeldokument" finden. Optimieren Sie die Optionen, um Ihre Dokumentation auf einer Seite zu gestalten.

Wenn Sie möchten, können Sie Ihre Archivierungsseite für die WordPress-Dokumentation genauso einrichten. Klicken Sie einfach auf die 'Archivseite' Registerkarte, während in der 'Layout' Tab.

Zuweisen und Verwalten von Benutzerrollen zur Optimierung der Arbeitslast

Dieser Schritt ist völlig optional. Wenn Sie ein Plugin-Entwickler sind und verschiedene Personen für die Erstellung und Verwaltung Ihrer Plugin-Dokumentation zuweisen möchten, können Sie dies tun Benutzerrollen in BetterDocs verwalten indem du zu gehst BetterDocs -> Einstellungen -> Erweiterte Einstellungen von Ihrem WordPress-Dashboard.

BetterDocs

Erstellen und veröffentlichen Sie Ihre WordPress-Dokumentation

Das ist der lustige Teil. Dies ist der Schritt, in dem wir Ihnen zeigen wie man Erstellen und veröffentlichen Sie eine neue Dokumentation in BetterDocs.

Du musst rüber gehen BetterDocs -> Neu hinzufügen von Ihrem WordPress-Dashboard. Dadurch wird der Editor für Sie geöffnet, in dem Sie den Inhalt Ihrer Dokumentation schreiben und Kategorien und Tags auswählen können.

Sortieren und organisieren Sie Ihre WordPress-Dokumentation mit Kategorien und Tags

Wir haben in unserem Handbuch erwähnt, wie wichtig es ist, Kategorien und Tags zum Einrichten einer einfallsreichen WordPress-Dokumentation zu verwenden. Hier in diesem Abschnitt zeigen wir es Ihnen wie man Dokumentation sortiert und organisiert in BetterDocs. Um Ihre Kategorien einzurichten, müssen Sie zu gehen BetterDocs -> Kategorien Über Ihr WordPress-Dashboard können Sie so viele Kategorien erstellen, wie Sie benötigen.

Später, wenn Sie Ihre Plugin-Dokumentation schreiben, können Sie diese Kategorien zuweisen und sehen, wie sie Ihnen helfen, Ihre Dokumentation nach der Veröffentlichung organisiert zu halten.

Schließen Sie die erweiterte Live-Suche für Ihre WordPress-Dokumentation ein

Mit BetterDocs haben Sie die Möglichkeit dazu Hinzufügen und Anpassen der Dokumentation Live-Suche. Navigieren Sie zu wp-admin -> BetterDocs -> Einstellungen. Öffnen Sie anschließend die 'Design' Tab. Jetzt drücken Sie die 'BetterDocs anpassen' Klicken Sie auf die Schaltfläche, und Sie werden zur Seite Anpassen weitergeleitet.

Mit diesem Customizer können Sie jetzt die Live-Suche für Ihre Dokumentation einrichten. Spielen Sie mit den Styling-Optionen und beobachten Sie Ihre Änderungen in Echtzeit. Wenn Sie mit Ihrem Stil zufrieden sind, speichern Sie Ihre Änderungen.

BetterDoc

Sofortige Antworten hinzufügen ChatBot für eine bessere Benutzererfahrung

Wenn Sie Ihre Support-Tickets noch weiter reduzieren und die Benutzererfahrung verbessern möchten, müssen Sie dies wissen wie man sofort antwortet in WordPress und verbessern Sie die Benutzererfahrung mit BetterDocs. Sie können diesen ChatBot für Sofortantworten auf jeder beliebigen Seite hinzufügen. Um es zu aktivieren, müssen Sie zu navigieren wp-admin -> BetterDocs -> Einstellungen Klicken Sie anschließend auf die Registerkarte "Sofortige Antwort".

Als nächstes müssen Sie den ChatBot für Sofortantworten nach Ihren Wünschen einrichten. Sie können die Optionen im Abschnitt "Chat-Einstellungen", im Abschnitt "Darstellungseinstellungen" und vielem mehr optimieren.

Sofortige Antworten ChatBot kann umfassend angepasst werden, um einen interaktiven ChatBot für Konversationen zu erstellen, der sich sofort um die Probleme Ihrer Benutzer kümmert. 

Eine bessere Vorstellung davon, wie der ChatBot für Sofortantworten von BetterDocs Ihre Dokumentationsseite wirklich hervorheben kann, finden Sie unter Easy.Jobs verwendet Instant Answers ChatBot auf ihrer Website.

WordPress-Dokumentation

Wie Sie sehen, reagiert ein Benutzer sofort auf die Fragen des Benutzers, wenn er auf den ChatBot für Sofortantworten klickt. Auf diese Weise können Sie mit BetterDocs die Benutzererfahrung verbessern und gleichzeitig die Support-Tickets mit dem ChatBot für Sofortantworten reduzieren.

Bewerten Sie die Leistung Ihrer WordPress-Dokumentation mit Analytics & Reports

Wir haben erwähnt, dass die Verbesserung Ihrer WordPress-Dokumentation ein wesentlicher Bestandteil der Einrichtung einer besseren Dokumentation ist. Der beste Weg, dies zu tun, besteht darin, die Leistung Ihrer Plugin-Dokumentation mit Analysen und Berichten zu bewerten. 

Sie können konfigurieren Analyse zur Bewertung der Leistung Ihrer Wissensbasis durch Navigieren zu wp-admin-> BetterDocs -> Einstellungen. Auf der Registerkarte "Allgemein" können Sie festlegen, wie Ihre Analytics angewendet werden sollen, und Bot Analytics aktivieren oder deaktivieren.

BetterDocs

Sie können die Erkenntnisse aus Ihren Analytics von überprüfen BetterDocs -> Analytics. Auf diese Weise erhalten Sie eine klare und aufschlussreiche Bewertung der Leistung Ihrer WordPress-Dokumentation.

BetterDocs

Einfache Migration vom vorhandenen Dokumentations-Plugin zu BetterDocs

Auch wenn Sie bereits ein anderes Dokumentations-Plugin verwenden, machen Sie sich keine Sorgen! Sie können mit nur wenigen Klicks problemlos auf BetterDocs migrieren. Weitere Informationen finden Sie in dieser Hilfe & lernen, wie man migriert bis BetterDocs. 

🎁 Grab An Exclusive for only WordPress Plugin Developer: BetterDocs Pro​ for FREE

Damit ist unser Leitfaden für eine bessere WordPress-Dokumentation für jeden Plugin-Entwickler abgeschlossen.

Wenn Sie ein Plugin-Entwickler sind und einen exklusiven Einblick in alles erhalten möchten, was BetterDocs zu bieten hat, dann haben Sie heute Glück! Wir verschenken eine kostenlose Lizenz für BetterDocs Pro Nur für Entwickler von WordPress-Plugins, die über ein Freemium-WordPress-Plugin verfügen und dann eine Dokumentationsseite erstellen möchten Füllen Sie dieses Formular unten aus und wir werden uns bei Ihnen melden.

Erhalten Sie Zugriff auf die BetterDocs PRO-Lizenz
Vorteile der Knowledge Base-Dokumentation zur Skalierung Ihres Kundensupports

Vorteile der Knowledge Base-Dokumentation zur Skalierung Ihres Kundensupports

Heutzutage Kunden Suche und Analyse der Produkte in Detail vor der Kaufentscheidung. Hier kann Ihr Unternehmen Ihren Verbraucher anhand einer Schritt-für-Schritt-Anleitung unter Verwendung einer selbstwartenden Wissensdatenbank informieren. In diesem Blog erfahren Sie mehr über einige wichtige Vorteile der Pflege einer Knowledge Base-Dokumentationssite zur Skalierung Ihrer Website Kundendienst.

Lesen Sie weiter "Benefits of Knowledge Base Documentation To Scale Your Customer Support"

So geben Sie eine sofortige Antwort in der WordPress-Dokumentation mit BetterDocs

Sofortige Antwort hilft Ihnen, die Antwort sofort zu erhalten, indem Sie sie durchsuchen. Auf jeder Knowledge Base-Seite funktioniert diese sofortige Unterstützung wie ein Booster, um das Publikum anzuleiten. Sie müssen nicht überall herumlaufen, um eine perfekte Lösung zu finden. Es bietet Ihren Besuchern sofort die richtige Dokumentationsunterstützung. Ihre Besucher können über dieses Formular ihre wertvolle Meinung abgeben. Dies wird Ihnen sicherlich dabei helfen, die Qualität Ihrer Dokumentation zu verbessern und Sie zu ermutigen, in Zukunft bessere Ergebnisse zu erzielen.

Sind Sie neugierig auf diese Besonderheit von BetterDocs? Dann lassen Sie uns unten mehr darüber erfahren!

Lesen Sie weiter "How To Provide Instant Answer In WordPress Documentation Using BetterDocs"