Organizeaza-te! Cum se creează un ghid de stil al bazei de cunoștințe

Scrierea unei baze de cunoștințe este deja destul de dificilă. Așa că îmi cer scuze pentru ceea ce urmează să fac în această postare. Îți voi spune că nu este vorba doar despre ideile din baza ta de cunoștințe, ci și despre modul în care le prezinți.

Vedeți, dincolo de aceste idei, trebuie să vă asigurați că sunteți întotdeauna:

• Folosind tonul potrivit
• Formatează în mod constant totul la fel

Ceea ce, din motive pe care le voi elucida în secțiunea următoare, este de fapt surprinzător de dificil. Acolo intră în joc un ghid de stil al bazei de cunoștințe.

De ce baza dvs. de cunoștințe ar putea fi o mizerie de stiluri diferite

Nu vă faceți griji prea mult dacă baza dvs. de cunoștințe este un amestec de stiluri diferite. Se întâmplă la o mulțime de companii, de obicei din unul dintre cele două motive (sau uneori ambele!).

În primul rând, dacă faci parte dintr-o echipă, este posibil să ai mai multe persoane care scriu documente de asistență. Astfel, dacă:

• Jim scrie articolul A
• Sally scrie articolul B

Aceste articole vor avea probabil stiluri și formatări extrem de diferite... cu excepția cazului în care aveți un ghid de stil predefinit.

Acum, dacă nu faci parte dintr-o echipă, probabil că spui: „Sunt un lup singuratic – scriu totul singur. Așa că nu trebuie să pun nimic pe hârtie – sunt tot eu!”

Și acesta ar putea fi cazul... dacă ați scris toate articolele din baza de cunoștințe dintr-o singură ședință.

Dar amândoi știm că nu așa funcționează de obicei lucrurile, nu? Probabil ați scris o grămadă de articole din baza de cunoștințe când ați lansat produsul pentru prima dată.

Dar apoi, la trei luni mai târziu, lansați o nouă funcție. Acum trebuie să scrieți intrarea în baza de cunoștințe pentru acea nouă caracteristică și... amintirile umane nu sunt atât de bune . Există șanse mari să ajungi să faci ceva diferit, chiar dacă nu încerci.

Deci, indiferent dacă sunteți singur sau faceți parte dintr-o echipă, merită să puneți ghidul de stil al bazei de cunoștințe pe hârtie.

Companiile chiar fac asta? Este un ghid de stil al bazei de cunoștințe un lucru real?

Ok, vă voi spune cum să vă creați ghidul de stil într-o secundă. Dar mai întâi, vreau să conduc cu câteva exemple de companii care realizează acest lucru. Acest lucru realizează două obiective:

• Vă arată că nu fac doar lucruri pentru a crea mai mult conținut de blog
• Vă oferă un exemplu din viața reală din care puteți trage pentru propriul ghid de stil.

Să ne uităm mai întâi la Mozilla. Mozilla are o intrare întreagă în ghidul de stil pentru baza lor de cunoștințe. Deoarece Mozilla este open source, este esențial pentru ei să aibă un ghid de stil pentru, cu propriile lor cuvinte, „să facă baza de cunoștințe de suport Firefox consistentă, rezultând o bază de cunoștințe, care este ușor de citit și la care să contribui”. Ușor de citit? Pare un obiectiv bun pentru baza ta de cunoștințe, nu?

Ghidul merge în profunzime, ghidându-vă prin toate, de la scriere cu majuscule, la spații albe, la virgule în serie.

În continuare, MailChimp's Voice & Tone este o altă lectură care merită. Deși nu este concentrat 100% pe baze de cunoștințe, are o serie de intrări atât pentru baza de cunoștințe, cât și pentru conținutul tutorialului:

În timp ce ghidul de stil al Mozilla se concentrează mai mult pe stil și formatare, MailChimp optează să se concentreze mai mult pe, ei bine, pe voce și pe ton, decât pe formatarea simplă.

Cum să creați un ghid de stil pentru baza dvs. de cunoștințe

Ți-am aruncat câteva exemple, dar încă nu ți-am oferit un proces pentru a crea propriul ghid de stil al bazei de cunoștințe. Deci, hai să reparăm asta!

Folosiți o persoană consecventă

Ați citit vreodată un articol în care autorul a schimbat între „eu” și „noi”? Am și vă putem spune că este extrem de confuz.

Deci, dacă veți folosi prima persoană - alegeți una și fiți consecvenți în privința ei. Chiar dacă ești singur, poți alege să folosești „noi”. Depinde de tine! Folosește-l pe același.

În plus, nici măcar nu trebuie să folosiți persoana întâi. Puteți opta pentru a evita cu totul „eu” și „noi”.

Nu există cu adevărat un răspuns corect aici - este vorba doar de consecvență.

Standardizați-vă formatarea

Dacă citiți ghidul nostru suprem de șabloane de articole din baza de cunoștințe, știți că bazele de cunoștințe bune folosesc o mulțime de instrucțiuni cu pași mici. Și acele instrucțiuni vor include, la un moment dat, limbaj precum:

Faceți clic pe Fișier .

Deci – este:

• Faceți clic pe File
• Faceți clic pe „Fișier”
• Faceți clic pe File

Și când îți scrii listele, este:

• Pasul 1: Faceți clic pe acesta
• Pasul 2: Faceți clic pe acesta

Sau este asa:

• Faceți clic pe aceasta
• Faceți clic pe asta

Din nou – îl poți alege pe cel care îți place cel mai mult – dar, indiferent pe care îl alegi, folosește-l în mod constant în întreaga ta bază de cunoștințe.

Există și alte opțiuni de formatare pe care trebuie să le faceți – ghidul de stil Mozilla vă oferă o idee bună despre tot ce trebuie acoperit, dar iată câteva idei de început:

• Litere cu majuscule ale titlurilor – veți folosi majuscule sau majuscule pentru titlu?
• Numere - este 10 sau zece?
• Abrevieri – nu fac sau nu?
• Acronime – CDN sau rețea de livrare de conținut?

Dacă utilizați una dintre temele sau pluginurile WordPress din baza noastră de cunoștințe, codurile scurte și opțiunile de formatare încorporate vă pot ajuta să rămâneți consecvent atunci când vine vorba de formatare

Obțineți vocea corectă

În cele din urmă, trebuie să treceți dincolo de formatare și să vă standardizați vocea.

Ești prietenul clientului tău? Sau ești Spock din Star Trek, care distribui cu nepăsare înțelepciune rece și dură?

În rațiune, oricare este bine. Atâta timp cât este consecvent.

În general, ar trebui să vă asigurați că urmați sfaturile ghidului din baza de cunoștințe MailChimp. Le sugerez nu numai pentru că MailChimp și-a publicat de fapt ghidul, ci și pentru că cred că MailChimp are una dintre cele mai bune baze de cunoștințe existente.

Sfatul lor este acesta:

• Faceți întotdeauna ca prioritate să răspundeți la întrebări și să vă informați cititorii. Glumele sunt ok uneori, dar nu dacă distrage atenția de la acel obiectiv esențial.
• Evitați să vorbiți ca un agent de marketing – doar încerci să ajuți.

Unde să-ți păstrezi ghidul de stil?

Nu ar trebui să iei doar aceste decizii. De asemenea, trebuie să le scrieți într-un loc sigur.

Personal, majoritatea ghidurilor de stil cu care lucrez sunt documente Google Docs. În acest fel, puteți partaja cu ușurință ghidul dvs. de stil și îl puteți accesa de pe diferite computere.

Dar dacă preferi o altă metodă, mergi cu ceea ce ești familiarizat. Singurul lucru cu adevărat important este acesta:

Aveți o copie a ghidului de stil al bazei de cunoștințe stocată într-un loc sigur, unde dvs. sau alții îl puteți accesa atunci când aveți nevoie de o actualizare despre cum să formatați baza de cunoștințe.

Deci, scrieți-l pe hârtie și începeți să creați articole mai consistente în baza de cunoștințe!