Jak dodać dokumentację w WordPress (krok po kroku)

Tworzenie dokładnej dokumentacji w witrynie WordPress jest niezbędne, jeśli chcesz skutecznie prowadzić i wspierać swoich użytkowników. Odpowiednia dokumentacja może pomóc im zrozumieć, jak korzystać z produktów lub usług, co prowadzi do lepszego ogólnego doświadczenia.

W ciągu ostatnich 16 lat zbudowaliśmy kilka stron internetowych, na których sprzedajemy wtyczki i kursy i zawsze dodajemy szczegółową dokumentację, aby wspierać naszych użytkowników. Obejmujemy wszystko, od procesu instalacji i przewodników po funkcjach po szczegóły dodatków, mając na celu ułatwienie rozwiązywania problemów.

Zauważyliśmy, że pomaga to użytkownikom w rozwiązywaniu ich własnych problemów i buduje zaufanie do naszych produktów, ponieważ czują się pewnie, wiedząc, że jasno uporządkowaliśmy wszystkie kluczowe informacje.

Dlatego zalecamy dodanie dokumentacji, niezależnie od tego, czy prowadzisz firmę skoncentrowaną na produktach, witrynę członkowską czy platformę edukacyjną.

W tym artykule pokażemy krok po kroku, jak łatwo dodać dokumentację w WordPress. Nasz przewodnik będzie bardzo łatwy do naśladowania i nie będzie wymagał żadnej wiedzy na temat kodowania.

Po co dodawać dokumentację w WordPress?

Dokumentacja to treść w witrynie WordPress, która zawiera informacje na temat korzystania z produktów/usług, w tym ich funkcji, nowych wersji, dodatków i nie tylko.

Dokumentacja WordPress może obejmować poradniki, przewodniki, często zadawane pytania, bazy wiedzy i dokumentację API.

Na przykład, jeśli masz sklep internetowy, który sprzedaje muzykę, możesz utworzyć dokumentację szczegółowo opisującą, jak pobrać muzykę, odnowić licencje lub utworzyć listę odtwarzania.

Dodanie dokumentacji w WordPressie może poprawić doświadczenie użytkownika, ułatwiając klientom odkrywanie różnych funkcji produktu, znajdowanie przyczyn ich problemów i samodzielne debugowanie. Może to nawet zmniejszyć liczbę zgłoszeń dotyczących pomocy technicznej dla twojej witryny.

Dokumentacja może również poprawić twoje rankingi SEO, dostarczając dodatkową treść, którą Google i inne wyszukiwarki mogą indeksować i wyświetlać w wynikach wyszukiwania.

Powiedziawszy to, zobaczmy, jak łatwo dodać dokumentację w WordPress, krok po kroku.

Jak dodać dokumentację w WordPress

Możesz łatwo dodać dokumentację w WordPressie za pomocą wtyczki Heroic KB.

Jest to najlepsza na rynku wtyczka do bazy wiedzy WordPress, która dodaje przeszukiwalną bazę wiedzy do Twojej witryny. Posiada funkcję wyszukiwania AJAX, porządkowanie treści metodą „przeciągnij i upuść”, załączniki do artykułów i wiele więcej.

Ponadto narzędzie ma wbudowane funkcje analityczne i uwagi użytkowników, które pozwalają zbierać spostrzeżenia w celu ulepszenia twojej istniejącej dokumentacji.

Jest nawet wyposażony w funkcję Heroic AI Assistant, która pozwala łatwo dodać własnego chatbota do twojej witryny internetowej. Chatbot jest szkolony bezpośrednio z twojej bazy wiedzy, dzięki czemu może zapewnić dokładne i spersonalizowane odpowiedzi dla twoich klientów.

Krok 1: Konfiguracja ustawień ogólnych Heroic KB

Najpierw należy zainstalować i włączyć wtyczkę Heroic KB. Aby uzyskać szczegółowe instrukcje, zobacz nasz przewodnik krok po kroku, jak zainstalować wtyczkę WordPress.

Po włączaniu, przejdź na stronę Heroic KB ” Ustawienia z panelu bocznego administratora WordPress i przełącz się na kartę „Licencja i aktualizacje”.

Tutaj wpisz klucz licencyjny twojej wtyczki i kliknij przycisk „Zapisz zmiany”. Możesz uzyskać te informacje ze swojego konta w witrynie internetowej Heroic KB.

Po dodaniu klucza licencyjnego należy przejść do karty 'Home & General’ z lewej kolumny. Należy wybrać stronę główną dokumentacji z rozwijanego menu obok opcji „KB Home Page”.

Jeśli wybierzesz opcję „Archiwum bazy wiedzy”, Heroic KB utworzy nową stronę dla twojej dokumentacji pod adresem www.example.com/knowledge-base.

Jeśli jednak chcesz dodać twoją dokumentację na stronie, którą już utworzyłeś, możesz wybrać tę opcję z rozwijanego menu.

Następnie możesz również wpisać rodzaj tekstu nagłówka, który będzie wyświetlany u góry twojej strony z dokumentacją.

Po wykonaniu tej czynności wystarczy zaznaczyć opcję „Okruszki”, aby ją włączyć.

W bazie wiedzy, okruszki są rodzajem pomocy nawigacyjnej, która pozwala użytkownikom zobaczyć, w jaki sposób dotarli do obecnej, aktualnej strony i nawigować z powrotem do poprzednich stron, takich jak ta: Strona główna ” Produkty ” Instalacja.

Następnie z rozwijanego menu możesz wybrać liczbę kolumn kategorii, które mają być wyświetlane na twojej stronie dokumentacji.

Następnie zaznacz opcję „Wyświetl liczbę kategorii KB”, jeśli chcesz wyświetlić liczbę artykułów napisanych dla każdej kategorii.

Następnie wybierz liczbę artykułów, które mają być wyświetlane w każdej kategorii na stronie głównej dokumentacji z rozwijanego menu „Artykuł kategorii KB”.

Następnie możesz zaznaczyć pola „Ukryj puste kategorie” i „Ukryj artykuły nieskategoryzowane”. W ten sposób ani obecne, aktualne puste kategorie, ani nieskategoryzowane artykuły nie będą wyświetlane na twojej stronie głównej dokumentacji.

Następnie możesz ograniczyć dostęp do dokumentacji WordPress tylko do logujących się użytkowników z rozwijanego menu „Ogranicz dostęp”.

Po zakończeniu kliknij przycisk „Zapisz zmiany”, aby zapisać twoje ustawienia.

Krok 2: Konfiguracja kategorii, tagów i ustawień artykułów

Teraz przejdź do karty „Kategorie i tagi” w lewej kolumnie. Tutaj możesz wybrać sposób sortowania twoich kategorii i tagów oraz liczbę artykułów, które będą wyświetlane dla każdej taksonomii.

Możesz również zaznaczyć pole „Fragment artykułu”, jeśli chcesz wyświetlić fragment artykułu pod każdym archiwum taksonomii w twojej dokumentacji.

Następnie wystarczy kliknąć przycisk „Zapisz zmiany” i przejść do karty „Artykuł”.

W tym miejscu możesz zaznaczyć różne pola, aby włączać sekcję komentarzy pod twoimi artykułami dokumentacji, wyświetlać biogramy autorów lub wyświetlać inne powiązane artykuły pod każdym poradnikiem.

Po dokonaniu wyboru wystarczy kliknąć przycisk „Zapisz zmiany”, aby zapisać twoje ustawienia.

Krok 3: Konfiguracja ustawień wyszukiwania i uproszczonej nazwy bazy wiedzy

Teraz przejdź do karty „Wyszukiwanie” i zaznacz pole „Skupienie wyszukiwania”, jeśli chcesz, aby mysz użytkownika automatycznie lądowała na polu wyszukiwania dokumentacji, gdy strona się wczytuje.

Następnie można również dodać tekst zastępczy dla pola wyszukiwania, wyświetlać zajawki artykułów w wynikach wyszukiwania, a nawet włączyć wtyczkę, aby podświetlała wyszukiwany termin w wynikach.

Gdy to zrobisz, kliknij „Zapisz zmiany” i przejdź do karty „Ślimaki”.

Tutaj możesz dodać uproszczone nazwy dla artykułów, kategorii i tagów Twojej dokumentacji.

Po dokonaniu wyboru, kliknij przycisk „Zapisz zmiany”, aby zapisać twoje ustawienia.

Krok 4: Konfiguracja panelu bocznego bazy wiedzy i ustawień stylu

Następnie przejdź do karty „Paski boczne”, aby wybrać układ dla paneli bocznych na twoich stronach dokumentacji.

Możesz wybrać różne pozycje dla głównego paska bocznego, paska bocznego kategorii i paska bocznego artykułów. Możesz nawet zaznaczyć opcję „Sticky Article Sidebar?”, aby włączyć przypięty panel boczny dla stron.

Gdy to zrobisz, kliknij „Zapisz zmiany” i przejdź do karty „Style”.

W tym miejscu możesz wybrać szerokość dokumentacji, kolor odnośnika, styl nagłówka i kolor tekstu według własnych upodobań.

Następnie kliknij przycisk „Zapisz zmiany”.

Krok 5: Konfiguracja uwag do artykułu i ustawień e-mail

Następnie należy przejść do karty „Uwagi do artykułów” i zaznaczyć opcję „Włącz uwagi”, aby umożliwić użytkownikom ocenę twoich artykułów.

Możesz nawet dodać system głosowania w górę / w dół dla twojej dokumentacji WordPress, zaznaczając te pola. Dzięki temu użytkownicy będą mogli powiedzieć ci, czy twoja dokumentacja pomaga rozwiązać ich problemy na front-endzie.

Teraz kliknij przycisk „Zapisz zmiany”, aby zapisać twoje ustawienia.

Teraz przejdź do karty „Raporty e-mail” w lewej kolumnie i zaznacz opcję „Włącz raporty e-mail?”, jeśli chcesz, aby Heroic KB wysyłał ci cotygodniowe raporty dotyczące twojej dokumentacji.

Raport ten będzie zawierał całkowitą liczbę zobacz i średnią ocenę twoich artykułów dokumentacyjnych, a nawet wyświetli listę najlepszych i najwyżej ocenianych artykułów w danym tygodniu.

Gdy to zrobisz, dodaj twój adres e-mail administratora do pola „Odbiorcy raportu”. Jeśli chcesz, możesz nawet dodać wiele adresów e-mail.

Następnie kliknij przycisk „Zapisz zmiany”, aby zapisać twoje ustawienia.

Teraz, gdy skonfigurowałeś wszystkie ustawienia wtyczki Heroic KB, nadszedł czas, aby rozpocząć tworzenie dokumentacji dla twojej witryny internetowej.

Krok 6: Stwórz dokumentację dla twojej witryny WordPress

Możesz tworzyć artykuły instruktażowe, bazę wiedzy, przewodniki i często zadawane pytania dla twojej dokumentacji.

Aby rozpocząć tworzenie nowego dokumentu, przejdź na stronę Heroic KB ” Add New Article z kokpitu WordPress.

Spowoduje to otwarcie edytora treści WordPress, w którym możesz dodać nagłówek dla twojego artykułu dokumentacyjnego i rozpocząć pisanie treści. Możesz również kliknąć przycisk dodawania bloku „+” w lewym górnym rogu, aby dodać różne bloki do twojej treści.

Po napisaniu artykułu do dokumentacji należy rozwinąć kartę „Kategorie” w panelu bloków i kliknąć odnośnik „Utwórz nową kategorię artykułów”.

Następnie wystarczy utworzyć kategorię dla pisanego artykułu.

Następnie rozwiń sekcję „Tagi” w panelu bloków i dodaj dowolną liczbę tagów dla twojego artykułu dokumentacji.

Można nawet dodać zajawkę artykułu, rozwijając kartę „Zajawka”.

Następnie rozwiń kartę „Dyskusja” i odznacz opcję „Zezwalaj na komentarze”, jeśli chcesz wyłączyć komentarze dla tego artykułu. Jeśli chcesz zezwolić użytkownikom na dodawanie komentarzy, możesz pozostawić to ustawienie bez zmian.

Możesz również dodawać załączniki do twoich artykułów w dokumentacji. Aby to zrobić, przewiń w dół do sekcji „Opcje artykułu” w edytorze bloków i kliknij przycisk „Dodaj lub prześlij pliki”.

Spowoduje to uruchomienie multimediów, z których można dodać dowolny załącznik.

Następnie zaznacz pole „Załączniki w nowym oknie”, jeśli chcesz, aby załączniki w artykule otwierały się w nowym oknie po kliknięciu.

Możesz również wyłączyć funkcję głosowania w górę / w dół dla określonych artykułów, przewijając w dół do sekcji „Opcje głosowania”.

W tym miejscu należy zaznaczyć opcję „Wyłącz głosowanie”, aby wyłączyć system głosowania w górę/w dół dla tego konkretnego artykułu.

Na koniec kliknij przycisk „Opublikuj” u góry, aby opublikować twój artykuł jako dokumentację.

Teraz powtórz proces ponownie, aby dodać wiele wpisów dla twojej dokumentacji w różnych kategoriach.

Gdy już to zrobisz, możesz łatwo zobaczyć dokumentację, odwiedzając stronę www.example.com/knowledge-base lub możesz przejść na własną stronę, którą wybrałeś dla swojej dokumentacji.

Krok 7: Zmień kolejność artykułów i kategorii w twojej dokumentacji

Dzięki Heroic KB możesz również zmienić kolejność artykułów wyświetlanych w Twojej bazie wiedzy WordPress. Aby to zrobić, przejdź na stronę Heroic KB Article Ordering z kokpitu WordPress.

Tutaj wybierz kategorię, dla której chcesz zmienić kolejność artykułów. Następnie przeciągnij i upuść artykuły, aby zmienić ich kolejność zgodnie z twoimi preferencjami.

Po zakończeniu pamiętaj, aby kliknąć przycisk „Zapisz zamówienie”, aby zapisać ustawienia.

Aby zmienić kolejność kategorii wyświetlanych na twojej stronie dokumentacji, przejdź na stronę Heroic KB ” Category Ordering z panelu bocznego administratora WordPress.

Po przejściu do menu możesz zmienić kolejność kategorii, przeciągając je i upuszczając. Po wprowadzeniu zmian kliknij przycisk „Zapisz kolejność”, aby zapisać ustawienia.

Pomyślnie utworzyłeś dokumentację dla twojej witryny internetowej i zmieniłeś jej kolejność kategorii i artykułów.

Bonus: Dodaj sekcję FAQ do twojej witryny WordPress

Dodanie dokumentacji WordPress to świetny sposób, aby pomóc twoim użytkownikom znaleźć potrzebne informacje. Możesz również dodać FAQ (często zadawane pytania) wraz z twoimi wpisami na blogu, aby odpowiedzieć na najczęściej zadawane pytania związane z treścią.

Może to zwiększyć zaangażowanie użytkowników na blogu WordPress i zbudować zaufanie i wiarygodność wśród użytkowników, dając im znać, że rozumiesz ich pytania i obawy.

Ponadto często zadawane pytania mogą poprawić twoje rankingi SEO, umożliwiając korzystanie ze słów kluczowych z długiego ogona, których użytkownicy często szukają w wyszukiwarkach.

Możesz łatwo dodać FAQ do swojej witryny internetowej za pomocą All in One SEO (AIOSEO). Jest to najlepsza wtyczka WordPress SEO na rynku, która pozwala łatwo zoptymalizować twoją witrynę internetową w celu poprawy pozycji w wyszukiwarkach.

AIOSEO posiada nawet przyjazny dla użytkownika blok FAQ, który można dodać bezpośrednio do edytora bloków, gdzie możesz wpisz pytania i odpowiedzi do twojej sekcji FAQ.

Wtyczka pozwala również dostosować sekcję FAQ z panelu bloków, w tym jej kolor tekstu, kolor tła, typografię i kontener tytułu, dzięki czemu AIOSEO jest najlepszą wtyczką WordPress FAQ na rynku.

Ponadto wtyczka zawiera znaczniki schematu FAQ, które mogą poprawić ocenę Twojej witryny internetowej i organiczny współczynnik klikalności, sprawiając, że Twoje często zadawane pytania pojawią się bezpośrednio w wynikach wyszukiwania Google.

Aby uzyskać bardziej szczegółowe instrukcje, zapoznaj się z naszym poradnikiem na temat dodawania sekcji często zadawanych pytań w WordPress.

Mamy nadzieję, że ten artykuł pomógł ci dowiedzieć się, jak dodać dokumentację w WordPress. Możesz również zapoznać się z naszym przewodnikiem dla początkujących, jak zatrudnić wirtualnych asystentów do swojej witryny WordPress i naszymi typami ekspertów dla najlepszego oprogramowania do dokumentacji technicznej dla WordPress.

If you liked this article, then please subscribe to our YouTube Channel for WordPress video tutorials. You can also find us on Twitter and Facebook.