Kako da napravite dokumentaciju ili bazu znanja u WordPress-u

Kako da na svom WordPress sajtu napravite urednu dokumentaciju ili bazu znanja: tip sadržaja, oblasti, redosled, bočni meni i pretraga, bez posebnih alata.

Svaki proizvod ili usluga pre ili kasnije dobije ista pitanja kupaca. Dobra dokumentacija na sajtu odgovara na njih umesto vas, u bilo koje doba dana, a Google i AI asistenti je čitaju i upućuju ljude na vaš sajt. Za to ne treba poseban sistem ni pretplata. WordPress koji već imate je dovoljan, ako dokumentaciju organizujete kako treba.

Kao primer koristimo dokumentaciju na ovom sajtu, napravljenu upravo na način opisan u nastavku.

Šta čini dobru dokumentaciju

  • Odvojena je od bloga. Uputstvo nije vest i ne treba da se gubi među člancima po datumu.
  • Ima jasan red. Čitalac vidi gde je i šta sledi: prvo instalacija, pa podešavanja, pa rešavanje problema.
  • Lako se pretražuje, i to samo kroz dokumentaciju, bez rezultata sa bloga i iz prodavnice.
  • Adrese su kratke i stabilne, jer na njih upućujete iz mejlova, tiketa i sa drugih strana.
  • Uvek je ažurna. Čitalac treba da vidi za koju verziju važi i kada je poslednji put dopunjena.

Korak 1: Poseban tip sadržaja

Napravite tip sadržaja „Dokumentacija“. Tako dokumentacija dobija svoj meni u administraciji, svoju listu i svoju arhivu na sajtu, na primer /dokumentacija/. Zašto je to bolje od članaka sa kategorijom, objasnili smo u članku o tome šta je custom post type.

Pri pravljenju tipa obratite pažnju na tri podešavanja:

  • Hijerarhijski i deo uređivača „Redosled i nadređeni“, ako želite poglavlja sa potpoglavljima.
  • Arhiva uključena, sa adresom koju ćete dugo koristiti.
  • Ključ i adresa latinicom, malim slovima i bez kvačica. Ključ kasnije ne menjajte.

Korak 2: Oblasti umesto kategorija bloga

Napravite taksonomiju samo za dokumentaciju, na primer „Oblast“, i u nju nekoliko širokih oblasti. Na ovom sajtu to su Plaćanje i prodavnica, Ćirilica i latinica, Sadržaj i struktura sajta i Brzina i izgled sajta.

  • Malo oblasti, široke. Oblast sa jednim dokumentom izgleda prazno.
  • Ne pravite potkategoriju sa istim imenom kao dokument. Ako je dokument „Podešavanje plaćanja“, potkategorija „Podešavanje plaćanja“ je samo duplikat.
  • Tagove ostavite za kasnije, kada bude dovoljno tekstova da se isti tag ponovi na više mesta.

Ako imate više proizvoda, oblast možete staviti i u adresu: /dokumentacija/placanje/podesavanje-banke/. Odlučite to na početku, jer kasna promena menja sve adrese.

Korak 3: Jedan dugačak dokument ili više kratkih

Oba pristupa su dobra, a izbor zavisi od proizvoda:

  • Jedan dokument po proizvodu, sa sadržajem na vrhu i poglavljima ispod. Lako se štampa, pretražuje sa Ctrl+F i čita u jednom dahu. Tako je urađena dokumentacija na ovom sajtu.
  • Više kratkih strana, po jedna za svako poglavlje, povezane prethodnom i sledećom stranom. Bolje je kada proizvod ima mnogo tema ili kada želite da svaka tema ima svoj rezultat u pretrazi.

Kod dugačkog dokumenta obavezno napravite sadržaj sa linkovima na poglavlja i dajte svakom poglavlju stalnu kotvu, na primer #cesta-pitanja, da biste u tiketima mogli da pošaljete link tačno na odgovor.

Korak 4: Redosled koji vi određujete

Blog ide od najnovijeg, a dokumentacija mora da ide logičnim redom: „Početak“ pre „Naprednih podešavanja“, bez obzira na to šta je napisano prvo. Uključite sopstveni redosled i složite zapise prevlačenjem u listi. Najvažniji dokument možete istaći na vrh arhive, kao zakačen post na blogu.

Korak 5: Navigacija

Čitalac u dokumentaciji ne sme da se izgubi. Tri stvari to rešavaju:

  • Putanja iznad naslova: Početna › Dokumentacija › Plaćanje › Podešavanje banke.
  • Bočni meni sa svim dokumentima grupisanim po oblasti i označenim dokumentom koji se čita.
  • Prethodna i sledeća strana na dnu, u istoj oblasti, ako dokumentaciju delite na više strana.

Korak 6: Pretraga samo kroz dokumentaciju

Obična WordPress pretraga traži po celom sajtu, pa na pitanje „povraćaj novca“ vrati i članke sa bloga i proizvode. U bočnu traku dokumentacije stavite pretragu koja traži samo u tipu „Dokumentacija“. Rezultati su tada kratki i tačni.

Korak 7: Kartice u arhivi

  • Upišite izvod u svaki dokument, jednu ili dve rečenice o tome šta pokriva. Automatski izvod često uhvati početak strane, a to nije dobar opis.
  • Umesto datuma objave prikažite datum poslednje izmene, ili verziju za koju dokument važi.
  • Vreme čitanja za dokumentaciju nema smisla, pa ga isključite.

Korak 8: Da vas nađu Google i AI asistenti

  • naslovi poglavlja neka budu pitanja ili radnje koje ljudi traže: „Kako da vratim novac kupcu“, a ne „Povraćaj“;
  • deo „Česta pitanja“ na kraju svakog dokumenta, sa kratkim i direktnim odgovorima;
  • tačni podaci u tekstu, a ne na slikama, jer tekst sa slike ni pretraživač ni asistent ne čitaju pouzdano;
  • na početku dokumenta verzija i datum, da čitalac i pretraživač znaju da je uputstvo sveže.

Sa dodatkom NikolicWP CPT

Sve korake iz ovog članka pokriva jedan dodatak, NikolicWP CPT (Custom Post Type):

Primer podešavanja baš za dokumentaciju nalazi se u dokumentaciji dodatka, u poglavlju „Primer: dokumentacija proizvoda“.

Česta pitanja

Zašto ne koristiti obične stranice za dokumentaciju?

Možete, ako imate pet strana koje se retko menjaju. Sa više strana stranice se mešaju sa Kontaktom i pravnim stranama, nemaju arhivu, oblasti ni pretragu samo kroz dokumentaciju.

Treba li dokumentaciji bočna traka?

Na arhivi i kod kratkih strana da: pretraga i meni sa svim dokumentima. Kod dugačkog dokumenta sa sopstvenim sadržajem bočna traka nije neophodna, a cela širina olakšava čitanje tabela.

Može li dokumentacija da bude samo za kupce?

Može, ali onda je Google ne vidi i ne dovodi vam nove kupce. Bolje je da osnovno uputstvo bude javno, a da samo posebni vodiči budu iza prijave.

Šta ako promenite temu?

Ako je tip sadržaja napravljen dodatkom, a ne u temi, dokumentacija ostaje gde jeste, sa istim adresama. Menja se samo izgled.

Ukratko: poseban tip sadržaja, nekoliko širokih oblasti, redosled koji vi određujete, bočni meni i pretraga samo kroz dokumentaciju. Tako kupci sami nalaze odgovore, a vi na pitanja odgovarate linkom umesto dugačkim mejlom.

Nik
Nik

Nik je mali robot napravljen od NikolicWP znaka. Dočeka vas u čarobnjaku za licencu, javi se kada je sve podešeno i potvrdi kada je nešto sačuvano. Kada vidite Nika, sve je u redu.