Organizzati! Come creare una guida di stile della Knowledge Base

Scrivere una base di conoscenza è già abbastanza difficile. Quindi mi scuso per quello che sto per fare in questo post. Ti dirò che non si tratta solo delle idee nella tua base di conoscenze, ma anche di come le presenti.

Vedi, al di là di queste idee, devi assicurarti di essere sempre:

• Usando il tono giusto
• Formattazione coerente tutto lo stesso

Il che, per ragioni che illustrerò nella prossima sezione, è in realtà sorprendentemente difficile. È qui che entra in gioco una guida allo stile della knowledge base.

Perché la tua base di conoscenza potrebbe essere un pasticcio di stili diversi

Non preoccuparti troppo se la tua base di conoscenze è un miscuglio di stili diversi. Succede a un sacco di aziende, di solito per uno dei due motivi (o talvolta entrambi!).

Innanzitutto, se fai parte di un team, potresti avere diverse persone che scrivono documenti di supporto. Quindi se:

• Jim scrive l' articolo A
• Sally scrive l' articolo B

Questi articoli probabilmente avranno stili e formattazioni molto diversi... a meno che tu non abbia una guida di stile predefinita.

Ora, se non fai parte di una squadra, probabilmente stai dicendo: “Sono un lupo solitario – scrivo tutto da solo. Quindi non ho bisogno di mettere niente su carta: sono tutto io!”

E questo potrebbe essere il caso... se scrivessi tutti gli articoli della tua knowledge base in una sola seduta.

Ma sappiamo entrambi che non è così che di solito funzionano le cose, giusto? Probabilmente hai scritto un mucchio di articoli della knowledge base quando hai rilasciato per la prima volta il tuo prodotto.

Ma poi, tre mesi dopo, rilasci una nuova funzionalità. Ora devi scrivere la voce della knowledge base per quella nuova funzionalità e... i ricordi umani non sono così belli . Ci sono buone probabilità che tu finisca per fare qualcosa di diverso, anche se non stai cercando di farlo.

Quindi, che tu sia da solo o parte di una squadra, vale la pena mettere su carta la tua guida allo stile della knowledge base.

Le aziende lo fanno davvero? Una guida di stile della Knowledge Base è una cosa reale?

Ok, ti ​​dirò come creare la tua guida di stile in un secondo. Ma prima, voglio guidare con alcuni esempi di aziende che stanno effettivamente facendo questo. Ciò raggiunge due obiettivi:

• Ti mostra che non sto solo inventando cose per creare più contenuti per il blog
• Ti dà un esempio di vita reale da cui puoi trarre la tua guida di stile.

Diamo prima un'occhiata a Mozilla. Mozilla ha un'intera voce nella guida di stile per la sua base di conoscenze. Poiché Mozilla è open source, è particolarmente essenziale per loro disporre di una guida di stile per, nelle loro stesse parole, "rendere coerente la Knowledge Base del supporto di Firefox, risultando in una base di conoscenza, che sia facile da leggere ea cui contribuire.". Facile da leggere? Sembra un buon obiettivo per la tua base di conoscenze, giusto?

La guida va in profondità, guidandoti attraverso tutto, dalle maiuscole, agli spazi bianchi, alle virgole seriali.

Successivamente, Voice & Tone di MailChimp è un'altra lettura utile. Sebbene non sia focalizzato al 100% sulle basi di conoscenza, ha una serie di voci sia per la base di conoscenza che per il contenuto del tutorial:

Mentre la guida allo stile di Mozilla è più incentrata sullo stile e sulla formattazione, MailChimp sceglie di concentrarsi maggiormente su voce e tono, piuttosto che sulla formattazione nitida.

Come creare una guida di stile per la tua base di conoscenza

Ti ho lanciato un paio di esempi, ma devo ancora darti un processo per creare effettivamente la tua guida allo stile della knowledge base. Quindi sistemiamolo!

Usa una persona coerente

Hai mai letto un articolo in cui l'autore passava avanti e indietro tra "Io" e "Noi"? Sì, e possiamo dirti che è estremamente confuso.

Quindi, se hai intenzione di usare la prima persona, scegline una e sii coerente. Anche se sei da solo, puoi comunque scegliere di usare "noi". Sta a te! Usa solo lo stesso.

Inoltre, non è nemmeno necessario utilizzare la prima persona. Puoi scegliere di evitare del tutto "io" e "noi".

Non c'è davvero una risposta giusta qui - si tratta solo di coerenza.

Standardizza la tua formattazione

Se leggi la nostra guida ai modelli di articolo della knowledge base definitiva, sai che le buone basi di conoscenza utilizzano molte istruzioni con piccoli passaggi. E quelle istruzioni, a un certo punto, includeranno un linguaggio come:

Fare clic su File .

Quindi - è:

• Fare clic su File
• Fare clic su "File"
• Fare clic su File

E quando scrivi effettivamente le tue liste, è:

• Passaggio 1: fare clic su questo
• Passaggio 2: fare clic su quello

Oppure è così:

• Fare clic su questo
• Fare clic su quello

Anche in questo caso, puoi scegliere quello che ti piace di più, ma quello che scegli, utilizzalo in modo coerente su tutta la tua base di conoscenze.

Ci sono anche altre scelte di formattazione che devi fare: la guida allo stile di Mozilla ti dà una buona idea di tutto da coprire, ma ecco alcune idee di partenza:

• Intestazione maiuscola : utilizzerai la maiuscola o il titolo maiuscolo?
• Numeri : sono 10 o dieci?
• Abbreviazioni : no o no?
• Acronimi : CDN o rete di distribuzione dei contenuti?

Se stai utilizzando uno dei nostri temi o plug-in WordPress della knowledge base, i nostri codici brevi e opzioni di formattazione integrati possono aiutarti a rimanere coerente quando si tratta di formattazione

Ottieni la voce giusta

Infine, devi andare oltre la formattazione e standardizzare la tua voce.

Sei amico del tuo cliente? O sei Spock di Star Trek, che dispensa spassionatamente saggezza fredda e dura?

Entro limiti ragionevoli, entrambi vanno bene. Finché è coerente.

In generale, dovresti assicurarti di seguire i suggerimenti della guida alla base di conoscenza di MailChimp. Li suggerisco non solo perché MailChimp ha effettivamente pubblicato la loro guida, ma anche perché penso che MailChimp abbia una delle migliori basi di conoscenza in circolazione.

Il loro consiglio è questo:

• Fai sempre la tua prima priorità per rispondere alle domande e informare i tuoi lettori. Le battute a volte vanno bene, ma non se distraggono da quell'obiettivo essenziale.
• Evita di parlare come un marketer: stai solo cercando di aiutare.

Dove conservare la tua guida di stile?

Non dovresti semplicemente prendere queste decisioni. Devi anche scriverli in un posto sicuro.

Personalmente, la maggior parte delle guide di stile con cui lavoro sono documenti di Google Docs. In questo modo, puoi condividere facilmente la tua guida di stile e accedervi da diversi computer.

Ma se preferisci un altro metodo, scegli quello che conosci. L'unica cosa veramente importante è questa:

Hai una copia della guida allo stile della tua knowledge base archiviata in un luogo sicuro a cui tu o altri potete accedervi quando avete bisogno di un aggiornamento su come formattare la vostra knowledge base.

Quindi, mettilo su carta e inizia a creare articoli di knowledge base più coerenti!