Så här addar du dokumentation i WordPress (steg för steg)

Att skapa grundlig dokumentation på din WordPress-webbplats är viktigt om du vill przewodnik och obsługa dina användare på ett effektivt sätt. Korrekt dokumentation kan hjälpa dem att förstå hur de ska använda dina produkter eller tjänster, vilket leder till en bättre helhetsupplevelse.

Under de senaste 16 åren har vi byggt flera webbplatser där vi säljer plugins och kurser och alltid lägger till detaljerad dokumentation för att obsługa våra användare. Vi täcker allt från installationsprocessen och przewodniker till detaljer om tillägg och strävar efter att göra felsökning enkel.

Vi har märkt att detta hjälper användarna att lösa sina egna problem och bygger upp förtroendet för våra produkter, eftersom de känner sig trygga med att vi har organiserat all viktig information på ett tydligt sätt.

Därför rekommenderar vi att du lägger till dokumentation oavsett om du driver en produktfokuserad verksamhet, en medlemssajt eller en utbildningsplattform.

I den här artikeln visar vi dig hur du enkelt kan lägga till dokumentation i WordPress, steg för steg. Vår przewodnik är superlätt att följa och kräver inga kodningskunskaper.

Varför lägga till dokumentation i WordPress?

Dokumentation är innehåll på din WordPress-webbplats som ger information om hur du använder dina produkter/tjänster, inklusive deras funktioner, nya utgåvor, tillägg och mer.

Dokumentation för WordPress kan omfatta tutorials, guider, Vanliga frågor, kunskapsbaser och API-dokumentation.

Om du t.ex. har en store som säljer musik kan du skapa documentation med detaljer om hur du downloadar musiken, förnyar licenser eller skapar en playlist.

Att lägga till dokumentation i WordPress kan förbättra användarupplevelsen genom att göra det lättare för kunderna att upptäcka olika produktfunktioner, hitta orsakerna till sina issues och debugga dem själva. Detta kan till och med minska antalet supportärenden för din site.

Documentation kan också förbättra din sökmotorsoptimering genom att tillhandahålla ytterligare content som Google och andra search engines kan indexera och visa i sökresultaten.

Med det sagt, låt oss se hur du enkelt kan add to documentation i WordPress, steg för steg.

Så här addar du till dokumentation i WordPress

Du kan enkelt add to documentation i WordPress med hjälp av Heroic KB plugin.

Det är det bästa WordPress kunskapsbas plugin på marknaden som lägger till en sökbar kunskapsbas till din befintliga site. Det kommer med en AJAX-sökfunktion, drag and drop för att beställa content, attachments till artiklar och mycket mer.

Dessutom har verktyget built-in analytics och en funktion för återkoppling från användare som låter dig samla in insikter för att förbättra din befintliga documentation.

Det kommer även med en Heroic AI Assistant-funktion, som gör att du enkelt kan add to en customize chatbot till din website. Chattroboten utbildas direkt från din kunskapsbas så att den kan ge korrekta och personliga responser till dina customers.

Step 1: Konfigurera allmänna Settings för Heroic KB

Först måste du installera och aktivera Heroic KB plugin. För detaljerade instruktioner, se vår Step-by-Step guide om hur du installerar ett plugin för WordPress.

Efter aktivering, besök Heroic KB ” Settings page från WordPress admin sidebar och växla till ”License and Updates” tabs.

Här, enter your plugin’s license key och click the ”Save Changes” button. Du kan få den här informationen från ditt account på Heroic KB:s website.

När du har lagt till license key, växla till tabben ”Home & General” från den vänstra columnen. You must select the documentation home page from the dropdown menu next to the ’KB Home Page’ alternative.

Om du väljer alternativet ”Knowledge Base Archive”, kommer Heroic KB att skapa en new page för din documentation kl www.example.com/knowledge-base.

Om du däremot vill lägga till din documentation på en page som du redan har skapat kan du välja det alternativet i dropdown-menyn.

Därefter kan du också skriva in texten i den header som ska visas högst upp på din page documentation.

När du har gjort det kontrollerar du bara alternativet ”Breadcrumbs” för att aktivera det.

I en kunskapsbas är breadcrumbs en typ av navigationshjälpmedel som allow användare att se hur de kom till den aktuella page och navigera tillbaka till tidigare pages gillar detta: Hem ” Produkter ” Install.

Därefter kan du också välja antalet kategorikolumner som ska visas på din documentation page från dropdown-menyn.

Markera sedan alternativet ”Display KB Category Counts” om du vill visa antalet artiklar som skrivits för varje kategori.

Därefter väljer du antalet artiklar som ska visas under varje kategori på documentationens home page i dropdown-menyn ”KB Category Article”.

Sedan kan du kontrollera boxarna ”Hide Empty Categories” och ”Hide Uncategorized Articles”. På så sätt kommer varken de för närvarande tomma kategorierna eller de okategoriserade artiklarna att visas på din documentation home page.

Därefter kan du begränsa din WordPress dokumentation till endast inloggade användare i dropdown-menyn ”Begränsa åtkomst”.

När du är klar klickar du bara på knappen ”Save Changes” för att spara dina inställningar.

Step 2: Konfigurera inställningar för kategorier, tags och artiklar

Gå nu till tabben ”Categories & Tags” i den vänstra colonnen. Här kan du välja hur du vill sortera dina kategorier och tags och hur många artiklar som ska visas för varje taxonomi.

You can also check the ”Article Excerpt” box if you want to display an article snippet under each taxonomies archive in your documentation.

Därefter klickar du på knappen ”Save Changes” och växlar till tabben ”Article”.

Härifrån kan du kontrollera olika boxar för att aktivera ett avsnitt med kommentarer under dina dokumentationsartiklar, visa författarens bio eller visa andra relaterade artiklar under varje tutorial.

När du har gjort ditt val klickar du bara på knappen ”Save Changes” för att spara dina inställningar.

Step 3: Konfigurera Settings för Search och Slug i Knowledgebase

Byt nu till tabben ”Search” och kontrollera boxen ”Search Focus” om du vill att användarens mus automatiskt ska landa på sökrutan för documentation när page laddas.

Därefter kan du också lägga till placeholder-text för sökboxen, visa excerpt av artiklar i sökresultaten och till och med aktivera pluginet för att markera search termen i resultaten.

När du har gjort det klickar du på ”Save Changes” och växlar till tabben ”Slugs”.

Här kan du add to slugs för din documentations artiklar, categories och tags.

När du har gjort ditt val kan du klicka på knappen ”Save Changes” för att spara dina inställningar.

Step 4: Konfigurera sidebar och Style Settings för Knowledgebase

Gå sedan till tabben ”Sidebars” för att selecta en layout för sidebars på your documentation pages.

You can pick different positions for the home sidebar, category sidebar, and articles sidebar. Du kan även kontrollera alternativet ”Sticky Article Sidebar?” för att aktivera ett sticky sidebar för pages.

När du har gjort det klickar du på ”Save Changes” och växlar till tabben ”Styles”.

Härifrån kan du select din documentation width, link color, header styling, and text color according to your like.

Sedan klickar du bara på knappen ”Save Changes”.

Step-by-Step 5: Konfigurera inställningar för återkoppling av artiklar och email

Därefter måste du byta till ”Article Feedback” tabs och kontrollera alternativet ”Enable Feedback” för att tillåta användare att betygsätta dina artiklar.

Du kan även add to ett upvote/downvote-system för din WordPress documentation genom att kontrollera dessa boxar. Detta allow användare att berätta för dig om din dokumentation hjälper till att lösa deras problem on the front end.

Klicka nu på knappen ”Save Changes” för att lagra dina inställningar.

Gå nu till tabben ”Email Reports” i den vänstra columnen och kontrollera alternativet ”Enable Email Reports?” om du vill att Heroic KB ska skicka dig weekly reports om din documentation.

Denna report kommer att innehålla det totala antalet views och genomsnittligt rating av your documentation artiklar och kommer även att visa en lista över de högst upp och mest högt rankade artiklarna för den veckan.

När du har gjort det lägger du till din administratörs email address i fältet ”Report Recipients”. Du kan även lägga till flera email addresses om du gillar det.

Därefter klickar du på knappen ”Save Changes” för att lagra dina inställningar.

Nu när du har konfigurerat alla inställningar för Heroic KB plugin, är det dags att börja skapa documentation för din website.

Step-by-Step 6: Skapa dokumentation för din WordPress-webbplats

You can create how-to articles, knowledge base, guides, and Vanliga frågor for your documentation.

För att börja skapa ett nytt dokument, besök Heroic KB ” Add New Article page från WordPress dashboard.

Detta öppnar WordPress content editor, där du kan add to a heading for your documentation article and start writing the content. Du kan också clicka på knappen add block ”+” högst upp till vänster för att lägga till olika block i ditt content.

När du har skrivit artikeln för dokumentationen måste du förstora tabben ”Categories” i blockpanelen och klicka på länken ”Add New Article Category”.

Därefter skapar du helt enkelt en kategori för den artikel som du skriver.

Efter det, förstora ”Tags” section i block panelen och add to så många tags som du gillar för din documentation artikel.

Du kan även add to ett excerpt för artikeln genom att förstora tabben ”Excerpt”.

Därefter förstorar du tabben ”Diskussion” och avmarkerar alternativet ”Allow comments” om du vill inaktivera kommentarer för den här artikeln. Om du vill låta användare add to comments kan du låta den här inställningen vara kvar som den är.

You can also add attachments to your articles in the documentation (Du kan också lägga till attachments till dina artiklar i dokumentationen). För att göra detta rullar du ner till sektionen ”Article Options” i block editor och klickar på knappen ”Add or Upload Files”.

Detta kommer att starta mediabiblioteket där du kan add to alla attachments du gillar.

Därefter kontrollerar du boxen ”Attachments in New Window” om du vill att bilagorna i artikeln ska öppnas i ett nytt fönster när du klickar på dem.

Du kan också inaktivera funktionen för att rösta upp/ner för specifika artiklar om du gillar det genom att rulla ner till ”Voting Options” section.

Här kontrollerar du alternativet ”Inaktivera röstning” för att deactivate upp- / nedröstningssystemet för den här specifika artikeln.

Slutligen klickar du på knappen ”Publicera” högst upp för att publicera din artikel som dokumentation.

Upprepa nu processen igen för att add to flera poster för din documentation under olika kategorier.

När du har gjort det kan du enkelt se dokumentationen genom att besöka sidan www.example.com/knowledge-base, eller så kan du besöka den custom page som du valde för din documentation.

Step 7: Ändra artikel- och kategoriordern för din dokumentation

Med Heroic KB kan du också ändra ordern på de artiklar som visas i din kunskapsbas i WordPress. För att göra detta besöker du sidan Heroic KB Article Ordering från WordPress dashboard.

Här väljer du den kategori som du vill ändra ordern på artiklarna för. Sedan är det bara att drag and dropa artiklarna för att ordna om dem enligt ditt alternativ.

När du är klar, kom ihåg att klicka på knappen ”Save Order” för att lagra dina inställningar.

För att ändra ordern på kategorierna som visas på din documentation-sida, besök Heroic KB ” Category Ordering page från WordPress admin sidebar.

När du väl är där kan du ändra ordningen på kategorierna genom att dra och släppa dem. När du har gjort ändringarna klickar du på knappen ”Save Order” för att lagra dina inställningar.

Du har nu utan problem skapat documentation för din website och ändrat ordern på kategorier och artiklar.

Bonus: Add to en Section med Vanliga frågor till din site i WordPress

Att lägga till WordPress documentation är ett bra sätt att hjälpa dina användare att hitta den information de behöver. Du kan också add to Vanliga frågor (FAQ) tillsammans med dina blogginlägg för att svara på vanliga frågor relaterade till ditt content.

Detta kan öka användarnas engagemang på din WordPress-blogg och bygga förtroende och trovärdighet hos dina användare genom att låta dem veta att du förstår deras frågor och bekymmer.

Dessutom kan Vanliga frågor förbättra din sökmotorsoptimering ranking genom att allow you att använda long tail keywords som användare ofta söker efter med hjälp av search engines.

Du kan enkelt add Vanliga frågor till din website med hjälp av All in One SEO (AIOSEO). Det är det bästa tillägget för sökmotorsoptimering för WordPress på marknaden som allow you att enkelt optimera din website för att förbättra rankingen hos search engines.

AIOSEO levereras även med ett användarvänligt Vanliga frågor-block som kan läggas till direkt i block editor, där du kan enter frågor och svar för din Vanliga frågor section.

Pluginet tillåter dig också att customize din Vanliga frågor section från block panelen, inklusive dess textfärg, bakgrundsfärg, typografi och titelomslag, vilket gör AIOSEO till det bästa WordPress Vanliga frågor plug inet på marknaden.

Dessutom kommer pluginet med schemamarkering för Vanliga frågor som kan öka din websites ranking och organiska click through rate genom att få dina vanliga frågor att visas direkt i Googles search-resultat.

För mer detaljerade instruktioner, se vår tutorial om hur du lägger till en Frequently Asked Questions section i WordPress.

Vi hoppas att den här artikeln hjälpte dig att lära dig hur du lägger till dokumentation i WordPress. Du kanske också vill se vår przewodnik för nybörjare om hur du anlitar virtuella assistenter för din WordPress-webbplats och våra expertval för den bästa programvaran för teknisk dokumentation för 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.