Dni
Godziny
Minuty
Sekundy

Use coupon '40BFCM' to get 40% discounts on BetterDocs PRO

Dokumentacja edytora wtyczek dokumentacji betterdocs wordpress

Ostateczny przewodnik po lepszej dokumentacji WordPress dla każdego programisty wtyczek

Jeśli jesteś programistą, który tworzy wtyczki dla WordPress, a następnie skonfiguruj Dokumentacja WordPress lub baza wiedzy powinna być istotną częścią strategii wsparcia klienta. W końcu korzystanie z własnej wtyczki może być bardzo łatwe, ale potencjalni klienci lub użytkownicy końcowi mogą potrzebować odpowiedniego przewodnika, aby naprawdę zrozumieć, jak działa Twoja wtyczka.

Dokumentacja edytora wtyczek dokumentacji betterdocs wordpress

Z tego powodu zdecydowanie powinieneś rozważyć poświęcenie czasu na skonfigurowanie właściwego, informacyjnego i użytecznego dokumentacja wtyczki dla użytkowników produktu. Bez oferty dokumentacja wtyczki Twoim użytkownikom będzie trudno osiągnąć sukces, ponieważ będziesz otrzymywać mnóstwo biletów pomocy technicznej.

Wyobraź sobie, jak byś się czuł, gdybyś kupił zupełnie nową pralkę, ale nie miałeś pojęcia, jak ją uruchomić, ponieważ przyszedł bez instrukcji ani instrukcji obsługi. Możesz zadzwonić do działu obsługi klienta, ale będziesz musiał długo czekać w kolejce, dopóki dział obsługi klienta odpowie na wszystkie pytania.

Więc jeśli jesteś Twórca wtyczki WordPress i chcesz, aby Twoi klienci mieli dobre wrażenia z korzystania z Twoich produktów, a następnie zastanów się nad stworzeniem zasobnej dokumentacji WordPress, która będzie dla nich łatwa w użyciu i zrozumieniu.

Mówiąc o znaczeniu dokumentacji dla wtyczek WordPress, Vova Feldman, założyciel Freemius udostępniono: 

„Dysponując odpowiednią dokumentacją, Ty i Twój zespół wsparcia możecie pracować wydajniej, kierując użytkowników do udokumentowanych tematów, zamiast pisać je w kółko. Usprawnia to UX dla użytkowników, którzy są wygodni w znajdowaniu rozwiązań w sposób samoobsługowy, co w naturalny sposób zmniejsza obsługa obciążenia ”.

Spis treści

Wszystko, co musisz wiedzieć o dokumentacji WordPress

Główny cel dokumentacji jest zapewnienie użytkownikom szczegółowych informacji o tym, jak mogą korzystać z Twojego produktu. Jest o wiele bardziej wszechstronny niż prosty FAQ (Często zadawane pytania) i powinna być łatwa do odczytania i zrozumienia dla osób, które nie mają wiedzy technicznej na temat Twojego produktu.

Podsumowując w skrócie, dokumentacja WordPress działa jak instrukcja obsługi produktu i powinna sprawić, że użytkownicy końcowi poczują się jak eksperci, gdy używają twoich wtyczek. 

Od nauczenia użytkowników, jak instalować i aktywować wtyczkę, do konfigurowania ustawień i dostosowywania za pomocą różnych funkcji, upewnij się, że dokumentacja wtyczki odpowiada na jak najwięcej pytań.

Zobaczmy, dlaczego jest to tak ważne dla każdego programisty wtyczek. Poniżej przedstawiamy bardzo krótki przegląd wszystkich korzyści, jakie może przynieść dokumentacja wtyczki.

👉Assist Non-Technical Users To Understand Your WordPress Plugin: Chociaż niektórzy z Twoich użytkowników końcowych mogą mieć wiedzę techniczną, większość użytkownicy na WordPress zwykle pochodzą z nietechnicznego zaplecza. Oznacza to, że musisz przedstawić dokumentację wtyczki WordPress, która jest łatwa do zrozumienia dla użytkowników nietechnicznych.

👉Enhance User Experience With A Detailed WordPress Documentation: Jeśli użytkownicy mogą dowiedzieć się, jak korzystać z wtyczki WordPress, po prostu przeglądając dostarczoną dokumentację wtyczki, poczują się wzmocnieni i zadowoleni z wtyczki WordPress.

👉Reduce Support Tickets & Workload On Your Team: Dobra dokumentacja WordPress może pomóc w zmniejszeniu liczby zgłoszeń do pomocy technicznej i obciążenia zespołu wsparcia. Jeśli użytkownicy końcowi mogą rozwiązać większość swoich problemów, czytając dokumentację wtyczki, nie będą musieli kontaktować się z zespołem pomocy technicznej.

👉Safeguard Yourself From Negative Reviews: Bez odpowiedniej dokumentacji WordPress użytkownicy mogą nie zrozumieć, jak działa Twoja wtyczka. Jest bardzo prawdopodobne, że użytkownicy poczują się tak sfrustrowani, że mogą zostawić negatywne opinie na temat wtyczek. Aby zabezpieczyć się przed negatywnymi recenzjami, zaoferuj bogatą w treść dokumentację WordPress.

👉SEO Benefits of Documentation: Posiadanie odpowiedniej dokumentacji pomaga zapewnić klientom wszystkie potrzebne informacje, ale będzie nieskuteczne, jeśli klienci nie będą mogli dowiedzieć się, gdzie uzyskać do nich dostęp. W tym przypadku baza wiedzy może być stosunkowo łatwym sposobem na umieszczenie rankingu na szczycie wyszukiwarki Google, jeśli odpowiednio zoptymalizujesz dokumentację pod kątem ruchu w wyszukiwarce.

Treść jest jednym z czterech głównych czynników rankingu algorytmu Google, a dokumentacja jest jednym ze źródeł treści dla Twojej witryny, ponieważ jest bardziej prawdopodobne, że będzie się zajmować pierwsze miejsca na najlepszych stronach z odpowiednimi optymalizacjami.

✅ Przewodnik po tworzeniu zasobnej dokumentacji WordPress

Aby skonfigurować przydatną dokumentację WordPress, która jest bogata w treść, musisz przestrzegać kilku podstawowych wskazówek. Przyjrzymy się im teraz.

Użyj prostego języka do dokumentacji wtyczki

Pamiętaj, że celem dokumentacji WordPress jest ułatwienie użytkownikom zrozumienia, jak korzystać z wtyczki bez potrzebująca specjalistycznej wiedzy technicznej. Unikaj używania żargonów technicznych, ponieważ użytkownicy nie posiadający wiedzy technicznej nie będą zaznajomieni z tymi warunkami.

Zapewnij użytkownikom łatwość odczytu

Informacyjna i zaradna dokumentacja WordPress prawdopodobnie zawiera dużo treści. Aby ułatwić użytkownikom szybkie czytanie całej zawartości dokumentacji wtyczki, należy używać krótkich akapitów, obrazów, list, punktów wypunktowanych, spisu treści i wielu innych. Wszystkie te ułatwią czytanie dokumentacji WordPress.

Postępuj zgodnie z właściwą strukturą dla swojej dokumentacji WordPress

Skuteczna i użyteczna dokumentacja WordPress będzie miała odpowiednią strukturę. Oznacza to, że cała zawartość dokumentacji wtyczki będzie postępować zgodnie z instrukcjami sekwencyjnymi krok po kroku.

Na przykład wszystkie wtyczki WordPress muszą zostać aktywowane po instalacji. Jeśli pominiesz etap aktywacji wtyczki, wielu użytkowników może nie zrozumieć, dlaczego wtyczka dla nich nie działa. Pisząc dokumentację wtyczki, pamiętaj o przestrzeganiu odpowiedniej, sekwencyjnej struktury, która ma sens dla użytkowników końcowych.

Aby uzyskać lepszy obraz tego, jak wygląda wysokiej jakości dokumentacja wtyczki WordPress, zapoznaj się z tymi stronami dokumentacji dla niektórych popularnych wtyczek WordPress.

Zorganizować Dokumentacja wtyczki z odpowiednimi kategoriami i tagami

Jest to bardzo ważna zasada, o której należy pamiętać podczas pisania dokumentacji wtyczki. Zawsze używaj odpowiednie kategorie i tagi do uporządkowania zawartości dokumentacji WordPress.

To jest Szczególnie ważne jeśli wtyczka ma mnóstwo funkcji, które oferują unikalne korzyści dla użytkowników. Ułatwia użytkownikom znajdowanie odpowiednich treści na stronie głównej dokumentacji.

Regularnie aktualizuj i ulepszaj dokumentację WordPress

Za każdym razem, gdy aktualizujesz i poprawiasz wtyczkę, musisz także aktualizować dokumentację WordPress, aby upewnić się, że informacje są przydatne dla użytkowników końcowych. W przeciwnym razie użytkownicy poczują się zdezorientowani i sfrustrowani, ponieważ nie będą w stanie zrozumieć dokumentacji wtyczki.

Postępując zgodnie z tymi wytycznymi, będziesz mógł tworzyć wysokiej jakości dokumentację WordPress, która jest odpowiednia i bogata w treści dla twoich użytkowników.  

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

Teraz, gdy wiesz, jak ważna jest dokumentacja wtyczki i wytyczne, których musisz przestrzegać, możesz się zastanawiać w jaki sposób dokładnie możesz stworzyć własną, bogatą w treść dokumentację WordPress. Najbardziej zaawansowanym rozwiązaniem do tworzenia wysokiej jakości dokumentacji WordPress jest BetterDocs.

BetterDocs jest najpotężniejszą wtyczką do dokumentacji, ponieważ bardzo pomaga skrócić czas i bilety wsparcia tworząc piękną, przeszukiwalną dokumentację WordPress. Przynosi ci to WPDeveloper, firma produktowa WordPress, która służąc więcej niż Ponad 700 000 użytkowników WordPress ze ponad 180 krajów. To jest ten sam zespół za Essential Addons dla Elementor, NotificationX i więcej.

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

Istnieje kilka specjalnych funkcji, które wyróżniają BetterDocs na tle wszystkich podobnych wtyczek. Z kolekcji pięknych, gotowe szablony, do łatwego w użyciu wbudowany moduł dostosowywania, BetterDocs ma wszystko, czego potrzeba, aby stworzyć atrakcyjną, zorganizowaną stronę dokumentacji w ciągu kilku minut. Funkcje te obejmują:

✔️ Zbiór gotowych, gotowych do użycia projektów szablonów 
✔️ Wbudowany dostosuj do stylu twoje strony dokumentacji
✔️ Automatycznie twórz lepkie Spis treści dla łatwiejszej nawigacji
✔️ Zaawansowane Wyszukiwanie na żywo aby szybko znaleźć odpowiednią treść
✔️ Śledź wydajność za pomocą Analityka i raport 
✔️ Natychmiastowe odpowiedzi ChatBot dla lepszego doświadczenia użytkownika 
✔️ SEO przyjazny dokumentacja z wykorzystaniem odpowiedniego znacznika schematu

🔥How To Use BetterDocs To Quickly Create Your WordPress Documentation

W tej sekcji nauczymy Cię, jak używać BetterDocs do szybkiego tworzenia Dokumentacji WordPress. Zaczniemy od podstaw, takich jak instalacja wtyczki BetterDocs dla WordPress, a następnie pokażemy, jak korzystać ze wszystkich fajnych funkcji, o których wspomnieliśmy wcześniej, aby utworzyć dokumentację wtyczki.

Zainstaluj i aktywuj wtyczkę BetterDocs dla WordPress

Pierwszą rzeczą, którą musisz zrobić, to znaleźć wtyczkę BetterDocs dla WordPress, przechodząc do wp-admin -> Wtyczki -> Dodaj nowe z pulpitu nawigacyjnego WordPress. Następnie musisz wpisać „BetterDocs” w polu wyszukiwania.

Po znalezieniu wtyczki po prostu zainstaluj i aktywuj to.

Skonfiguruj stronę główną i pojedynczą dokumentację za pomocą BetterDocs

Następnym krokiem po instalacji i aktywacji BetterDocs jest skonfiguruj stronę główną dokumentacji.

To jest bardzo łatwe do zrobienia. Domyślnie BetterDocs ma własną stronę główną dokumentacji, którą można dostosować w dowolny sposób. Jeśli jednak chcesz przypisać własny układ strony, możesz to zrobić, wyłączając domyślną stronę główną i używając krótkich kodów lub widgetów do tworzenia stron.

Aby skonfigurować i dostosować domyślną stronę główną dostarczaną z BetterDocs, przejdź do BetterDocs -> Ustawienia -> Układ. Wybierz liczbę kolumn, włącz lub wyłącz wyszukiwanie na żywo i układ murów, liczbę postów i wiele więcej.

Jeśli chcesz skonfigurować poszczególne strony dokumentacji, wszystko, co musisz zrobić, to wybrać „Single Doc” , gdy jesteś w 'Układ' zakładkę, aż znajdziesz opcję „Pojedynczy dokument”. Ulepsz z opcjami stylizowania dokumentacji na pojedynczą stronę.

Jeśli chcesz, możesz również skonfigurować stronę archiwum dokumentacji WordPress w dokładnie taki sam sposób. Po prostu kliknij „Strona archiwów” podczas gdy w 'Układ' patka.

Przypisywanie ról użytkowników i zarządzanie nimi w celu usprawnienia obciążenia

Ten krok jest całkowicie opcjonalny. Jeśli jesteś programistą wtyczek i chcesz wyznaczyć różne osoby do tworzenia dokumentacji wtyczek i zarządzania nią, możesz to zrobić zarządzaj rolami użytkowników w BetterDocs idąc do BetterDocs -> Ustawienia -> Ustawienia zaawansowane z pulpitu WordPress.

BetterDocs

Utwórz i opublikuj dokumentację WordPress

To jest fajna część. To jest krok, w którym ci pokażemy jak utwórz i opublikuj nową dokumentację w BetterDocs.

Musisz udać się do BetterDocs -> Dodaj nowy z pulpitu WordPress. Otworzy się dla ciebie edytor, w którym możesz pisać zawartość swojej dokumentacji, a także wybierać kategorie i tagi.

Sortuj i organizuj dokumentację WordPress za pomocą kategorii i tagów

Wspominaliśmy o tym, jak ważne jest używanie kategorii i tagów w naszym przewodniku po tworzeniu zasobnej Dokumentacji WordPress. Tutaj, w tej sekcji, pokażemy ci jak sortować i organizować dokumentację w BetterDocs. Aby skonfigurować kategorie, musisz przejść do BetterDocs -> Kategorie z pulpitu WordPress, w którym możesz utworzyć tyle kategorii, ile potrzebujesz.

Później, gdy piszesz dokumentację wtyczki, możesz przypisać te kategorie i zobaczyć, w jaki sposób pomagają one uporządkować dokumentację po ich opublikowaniu..

Dołącz zaawansowane wyszukiwanie na żywo do swojej dokumentacji WordPress

Z BetterDocs masz opcję dodawać i dostosowywać dokumentację na żywo. Nawigować do wp-admin -> BetterDocs -> Ustawienia. Następnie otwórz 'Projekt' patka. Teraz naciśnij „Dostosuj BetterDocs” zostaniesz przekierowany na stronę Dostosuj.

Teraz w tym narzędziu dostosowywania możesz skonfigurować wyszukiwanie na żywo swojej dokumentacji. Baw się z opcjami stylizacji i obserwuj zmiany w czasie rzeczywistym. Kiedy będziesz zadowolony ze swojego stylu, pamiętaj o zapisaniu zmian.

BetterDoc

Dodaj natychmiastowe odpowiedzi ChatBot dla lepszego doświadczenia użytkownika

Jeśli chcesz jeszcze bardziej zmniejszyć liczbę zgłoszeń do pomocy technicznej i zwiększyć wygodę użytkowników, musisz o tym wiedzieć jak zapewnić natychmiastową odpowiedź w WordPress i popraw jakość obsługi dzięki BetterDocs. Możesz dodać ten Instant Answer ChatBot na dowolnej stronie, którą lubisz. Aby go włączyć, musisz przejść do wp-admin -> BetterDocs -> Ustawienia a następnie kliknij kartę „Natychmiastowa odpowiedź”.

Następnie musisz skonfigurować InstantBat ChatBot zgodnie z własnymi preferencjami. Możesz dostosowywać opcje w sekcji „Ustawienia czatu”, sekcji „Ustawienia wyglądu” i wielu innych.

Natychmiastowe odpowiedzi ChatBot można szeroko dostosować, aby stworzyć interaktywny ChatBot konwersacyjny, który natychmiast zajmie się problemami użytkowników. 

Aby dowiedzieć się, jak InstantBat ChatBot od BetterDocs może naprawdę wyróżnić twoją stronę dokumentacji, zobacz jak Easy.Jobs korzysta z Instant Answers ChatBot na swojej stronie.

Dokumentacja WordPress

Jak widać, ilekroć użytkownik kliknie InstantBat ChatBot, natychmiast reaguje na zapytania użytkownika. W ten sposób BetterDocs pomaga zwiększyć komfort użytkowania, a jednocześnie zmniejsza liczbę zgłoszeń do pomocy technicznej za pomocą InstantBat Chatbot.

Oceń wydajność swojej dokumentacji WordPress za pomocą analiz i raportów

Wspomnieliśmy, że ulepszenie dokumentacji WordPress jest istotną częścią tworzenia lepszej dokumentacji. Najlepszym sposobem na to jest ocena wydajności dokumentacji wtyczki za pomocą analiz i raportów. 

Możesz skonfigurować analizy w celu oceny wydajności swojej bazy wiedzy, przechodząc do wp-admin-> BetterDocs -> Ustawienia. Na karcie „Ogólne” możesz ustawić sposób, w jaki chcesz stosować Analytics, a także włączyć lub wyłączyć Bot Analytics.

BetterDocs

Możesz sprawdzić dane z Analytics z BetterDocs -> Analytics. To da ci jasną, wnikliwą ocenę tego, jak działa twoja dokumentacja WordPress.

BetterDocs

Łatwo migruj z istniejącej wtyczki dokumentacji do BetterDocs

Nawet jeśli już używasz innej wtyczki dokumentacji, nie martw się! Możesz łatwo migrować do BetterDocs za pomocą zaledwie kilku kliknięć. Aby uzyskać więcej informacji, zapoznaj się z tymi szczegółowymi przewodnikami pomocy i dowiedz się, jak migrować do BetterDocs. 

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

Na tym kończy się nasz przewodnik po lepszej dokumentacji WordPress dla każdego programisty wtyczek.

Jeśli jesteś programistą wtyczek i chcesz uzyskać ekskluzywne spojrzenie na wszystko, co ma do zaoferowania BetterDocs, masz dziś szczęście! Rozdajemy darmowa licencja na BetterDocs Pro tylko dla programistów wtyczek WordPress, którzy mają darmową wtyczkę WordPress i chcą zbudować stronę dokumentacji, a następnie wypełnij poniższy formularz, a my skontaktujemy się z Tobą.

Uzyskaj dostęp do licencji BetterDocs PRO