Organize-se! Como criar um guia de estilo da base de conhecimento

Escrever uma base de conhecimento já é bastante difícil. Então, peço desculpas pelo que estou prestes a fazer neste post. Vou lhe dizer que não se trata apenas das ideias em sua base de conhecimento, mas também de como você as apresenta.

Veja, além dessas ideias, você precisa garantir que esteja sempre:

• Usando o tom adequado
• Formatação consistente de tudo igual

O que, por razões que explicarei na próxima seção, é surpreendentemente difícil. É aí que um guia de estilo da base de conhecimento entra em ação.

Por que sua base de conhecimento pode ser uma bagunça de estilos diferentes

Não se preocupe muito se sua base de conhecimento for uma mistura de estilos diferentes. Isso acontece com uma tonelada de empresas, geralmente por um dos dois motivos (ou às vezes ambos!).

Primeiro, se você faz parte de uma equipe, pode ter pessoas diferentes escrevendo documentos de suporte. Então se:

• Jim escreve o artigo A
• Sally escreve o artigo B

Esses artigos provavelmente terão estilos e formatação muito diferentes... a menos que você tenha um guia de estilo pré-definido.

Agora, se você não faz parte de uma equipe, provavelmente está dizendo: “Sou um lobo solitário – estou escrevendo tudo sozinho. Então não preciso colocar nada no papel – sou tudo eu!”

E esse pode ser o caso... se você escrevesse todos os seus artigos da base de conhecimento de uma só vez.

Mas nós dois sabemos que não é assim que as coisas geralmente funcionam, certo? Você provavelmente escreveu um monte de artigos da base de conhecimento quando lançou seu produto pela primeira vez.

Mas então, três meses depois, você lança um novo recurso. Agora você tem que escrever a entrada da base de conhecimento para esse novo recurso e… as memórias humanas não são tão boas . Há uma boa chance de você acabar fazendo algo diferente, mesmo que não esteja tentando.

Portanto, se você está sozinho ou faz parte de uma equipe, vale a pena colocar seu guia de estilo da base de conhecimento no papel.

As empresas realmente fazem isso? Um guia de estilo da base de conhecimento é uma coisa real?

Ok, eu vou te dizer como criar seu guia de estilo em um segundo. Mas primeiro, quero dar alguns exemplos de empresas que estão realmente fazendo isso. Isso cumpre dois objetivos:

• Isso mostra que não estou apenas inventando coisas para criar mais conteúdo de blog
• Ele fornece um exemplo da vida real que você pode usar para seu próprio guia de estilo.

Vamos olhar para o Mozilla primeiro. A Mozilla tem uma entrada completa no guia de estilo para sua base de conhecimento. Como o Mozilla é de código aberto, é especialmente essencial que eles tenham um guia de estilo para, em suas próprias palavras, “tornar a Base de Conhecimento de suporte do Firefox consistente, resultando em uma base de conhecimento fácil de ler e contribuir”. Fácil de ler? Isso soa como uma boa meta para sua base de conhecimento, certo?

O guia é profundo, levando você a tudo, desde letras maiúsculas, espaços em branco, até vírgulas seriais.

Em seguida, Voice & Tone do MailChimp é outra leitura que vale a pena. Embora não seja 100% focado em bases de conhecimento, ele possui várias entradas para a base de conhecimento e o conteúdo do tutorial:

Enquanto o guia de estilo da Mozilla é mais focado no estilo e na formatação, o MailChimp opta por se concentrar mais na voz e no tom do que na formatação detalhada.

Como criar um guia de estilo para sua base de conhecimento

Eu joguei alguns exemplos para você, mas ainda tenho que lhe dar um processo para realmente criar seu próprio guia de estilo de base de conhecimento. Então vamos corrigir isso!

Use uma pessoa consistente

Você já leu um artigo em que o autor alternava entre “eu” e “nós”? Eu tenho, e podemos dizer que é extremamente confuso.

Então, se você for usar a primeira pessoa – escolha uma e seja consistente sobre ela. Mesmo se você estiver sozinho, você ainda pode optar por usar “nós”. Você decide! Basta usar o mesmo.

Além disso, você nem precisa usar a primeira pessoa. Você pode optar por evitar “eu” e “nós” completamente.

Não há realmente uma resposta certa aqui – é apenas uma questão de consistência.

Padronize sua formatação

Se você ler nosso guia de modelo de artigo de base de conhecimento definitivo, saberá que boas bases de conhecimento usam muitas instruções com pequenas etapas. E essas instruções, em algum momento, incluirão linguagem como:

Clique em Arquivo .

Então é isso:

• Clique em Arquivo
• Clique em “Arquivo”
• Clique em Arquivo

E quando você realmente escreve suas listas, é:

• Passo 1: Clique aqui
• Passo 2: Clique nele

Ou é assim:

• Clique aqui
• Clique nisso

Novamente – você pode escolher o que você mais gosta – mas o que você escolher, use-o de forma consistente em toda a sua base de conhecimento.

Existem outras opções de formatação que você precisa fazer também – o guia de estilo da Mozilla dá uma boa ideia de tudo a ser abordado, mas aqui estão algumas ideias iniciais:

• Capitalização do título – você usará maiúsculas ou minúsculas?
• Números – é 10 ou dez?
• Abreviaturas – não ou não?
• Siglas – CDN ou rede de entrega de conteúdo?

Se você estiver usando um dos nossos temas ou plugins WordPress da base de conhecimento, nossos códigos de acesso integrados e opções de formatação podem ajudá-lo a permanecer consistente quando se trata de formatação

Obter a voz certa

Por fim, você precisa ir além da formatação e padronizar sua voz.

Você é amigo do seu cliente? Ou você é Spock de Star Trek, dispensando desapaixonadamente uma sabedoria dura e fria?

Dentro do razoável, qualquer um está bem. Desde que seja consistente.

Em geral, você deve seguir as dicas do guia da base de conhecimento do MailChimp. Eu os sugiro não apenas porque o MailChimp realmente publicou seu guia, mas também porque acho que o MailChimp tem uma das melhores bases de conhecimento existentes.

O conselho deles é este:

• Sempre faça sua primeira prioridade para responder a perguntas e informar seus leitores. Piadas são boas às vezes, mas não se distrair desse objetivo essencial.
• Evite falar como um profissional de marketing – você está apenas tentando ajudar.

Onde guardar seu guia de estilo?

Você não deve apenas tomar essas decisões. Você também precisa, você sabe, anotá-las em um lugar seguro.

Pessoalmente, a maioria dos guias de estilo com os quais trabalho são documentos do Google Docs. Dessa forma, você pode compartilhar facilmente seu guia de estilo e acessá-lo em diferentes computadores.

Mas se você preferir outro método, vá com o que você conhece. A única coisa realmente importante é isso:

Você tem uma cópia do guia de estilo da sua base de conhecimento armazenada em um local seguro onde você ou outras pessoas podem acessá-la quando precisar de uma atualização sobre como formatar sua base de conhecimento.

Então, coloque no papel e comece a criar artigos de base de conhecimento mais consistentes!