Como adicionar documentação no WordPress (passo a passo)

Criar uma documentação completa no seu site WordPress é essencial se você quiser orientar e dar suporte aos seus usuários de forma eficaz. A documentação adequada pode ajudá-los a entender como usar seus produtos ou serviços, levando a uma melhor experiência geral.

Nos últimos 16 anos, criamos vários sites onde vendemos plug-ins e cursos e sempre adicionamos documentação detalhada para dar suporte aos nossos usuários. Cobrimos tudo, desde o processo de instalação e guias de recursos até detalhes de complementos, com o objetivo de facilitar a solução de problemas.

Percebemos que isso ajuda os usuários a resolver seus próprios problemas e aumenta a confiança em nossos produtos, pois eles se sentem confiantes sabendo que organizamos claramente todas as informações importantes.

É por isso que recomendamos adicionar documentação, quer você esteja administrando um negócio focado em produtos, um site de associação ou uma plataforma educacional.

Neste artigo, mostraremos a você como adicionar facilmente documentação no WordPress, passo a passo. Nosso guia será muito fácil de seguir e não exigirá nenhum conhecimento de programação.

Por que adicionar documentação no WordPress?

Documentação é o conteúdo do seu site WordPress que fornece informações sobre como usar seus produtos/serviços, inclusive seus recursos, novas versões, complementos e muito mais.

A documentação do WordPress pode incluir tutoriais de instruções, guias, perguntas frequentes, bases de conhecimento e documentação de API.

Por exemplo, se você tiver uma loja on-line que vende música, poderá criar uma documentação detalhando como fazer o download da música, renovar licenças ou criar uma lista de reprodução.

A inclusão de documentação no WordPress pode melhorar a experiência do usuário, facilitando para os clientes a descoberta de diferentes recursos do produto, a identificação das causas dos problemas e a depuração por conta própria. Isso pode até reduzir o número de tíquetes de suporte para seu site.

A documentação também pode melhorar suas classificações de SEO, fornecendo conteúdo adicional que o Google e outros mecanismos de pesquisa podem indexar e exibir nos resultados de pesquisa.

Dito isso, vamos ver como adicionar facilmente a documentação no WordPress, passo a passo.

Como adicionar documentação no WordPress

Você pode adicionar facilmente a documentação no WordPress usando o plug-in Heroic KB.

É o melhor plug-in de base de conhecimento do WordPress no mercado que adiciona uma base de conhecimento pesquisável ao seu site existente. Ele vem com um recurso de pesquisa AJAX, ordenação de conteúdo por arrastar e soltar, anexos de artigos e muito mais.

Além disso, a ferramenta tem análises integradas e um recurso de feedback do usuário que permite coletar insights para melhorar a documentação existente.

Ele ainda vem com um recurso Heroic AI Assistant, que permite que você adicione facilmente um chatbot personalizado ao seu site. O chatbot é treinado diretamente de sua base de conhecimento para que possa fornecer respostas precisas e personalizadas aos seus clientes.

Etapa 1: Configurar as definições gerais do Heroic KB

Primeiro, você precisa instalar e ativar o plug-in Heroic KB. Para obter instruções detalhadas, consulte nosso guia passo a passo sobre como instalar um plug-in do WordPress.

Após a ativação, acesse a página Heroic KB ” Settings (Configurações ) na barra lateral do administrador do WordPress e vá para a guia “License and Updates” (Licença e atualizações).

Aqui, insira a chave de licença do plug-in e clique no botão “Save Changes” (Salvar alterações). Você pode obter essas informações em sua conta no site do Heroic KB.

Depois de adicionar a chave de licença, mude para a guia “Home & General” na coluna da esquerda. Você deve selecionar a página inicial da documentação no menu suspenso ao lado da opção “KB Home Page”.

Se você escolher a opção “Knowledge Base Archive”, o Heroic KB criará uma nova página para sua documentação em www.example.com/knowledge-base.

No entanto, se quiser adicionar a documentação em uma página que já tenha criado, você poderá escolher essa opção no menu suspenso.

Em seguida, você também pode digitar o texto do cabeçalho que será exibido na parte superior da página de documentação.

Depois de fazer isso, basta marcar a opção “Breadcrumbs” para ativá-la.

Em uma base de conhecimento, os breadcrumbs são um tipo de auxílio à navegação que permite que os usuários vejam como chegaram à página atual e voltem às páginas anteriores, como esta: Página inicial ” Produtos ” Instalação.

Em seguida, você também pode escolher o número de colunas de categoria a serem exibidas na página de documentação no menu suspenso.

Em seguida, marque a opção “Display KB Category Counts” (Exibir contagens de categorias KB) se você quiser exibir o número de artigos escritos para cada categoria.

Em seguida, escolha o número de artigos que devem ser exibidos em cada categoria na página inicial da documentação no menu suspenso “KB Category Article”.

Em seguida, você pode marcar as caixas “Hide Empty Categories” (Ocultar categorias vazias) e “Hide Uncategorized Articles” (Ocultar artigos não categorizados). Dessa forma, nem as categorias atualmente vazias nem os artigos não categorizados serão exibidos na página inicial de sua documentação.

Depois disso, você pode restringir o acesso à documentação do WordPress apenas para usuários conectados no menu suspenso “Restrict Access” (Restringir acesso).

Quando terminar, basta clicar no botão “Save Changes” (Salvar alterações) para armazenar suas configurações.

Etapa 2: Configurar categorias, tags e definições de artigos

Agora, mude para a guia “Categories & Tags” na coluna da esquerda. Aqui, você pode escolher como classificar suas categorias e tags e o número de artigos que serão exibidos para cada taxonomia.

Você também pode marcar a caixa “Article Excerpt” (Trecho de artigo) se quiser exibir um trecho de artigo sob cada arquivo de taxonomia em sua documentação.

Em seguida, basta clicar no botão “Save Changes” (Salvar alterações) e mudar para a guia “Article” (Artigo).

Aqui, você pode marcar diferentes caixas para ativar uma seção de comentários nos artigos de documentação, exibir biografias de autores ou mostrar outros artigos relacionados em cada tutorial.

Depois de fazer sua escolha, basta clicar no botão “Save Changes” (Salvar alterações) para armazenar suas configurações.

Etapa 3: Configurar a busca na base de conhecimento e as configurações de slug

Agora, mude para a guia “Search” (Pesquisa) e marque a caixa “Search Focus” (Foco na pesquisa) se quiser que o mouse do usuário pouse automaticamente na caixa de pesquisa da documentação quando a página for carregada.

Em seguida, você também pode adicionar texto de espaço reservado para a caixa de pesquisa, exibir trechos de artigos nos resultados da pesquisa e até mesmo ativar o plug-in para destacar o termo de pesquisa nos resultados.

Depois de fazer isso, clique em “Save Changes” (Salvar alterações) e vá para a guia “Slugs”.

Aqui, você pode adicionar slugs para os artigos, categorias e tags de sua documentação.

Depois de fazer sua escolha, clique no botão “Save Changes” (Salvar alterações) para armazenar suas configurações.

Etapa 4: Configurar a barra lateral e as definições de estilo da base de conhecimento

Em seguida, vá para a guia “Sidebars” (Barras laterais) para selecionar um layout para as barras laterais em suas páginas de documentação.

Você pode escolher diferentes posições para a barra lateral da página inicial, a barra lateral de categorias e a barra lateral de artigos. Você pode até marcar a opção “Sticky Article Sidebar?” para ativar uma barra lateral fixa para as páginas.

Depois de fazer isso, clique em “Save Changes” (Salvar alterações) e vá para a guia “Styles” (Estilos).

A partir daí, você pode selecionar a largura da documentação, a cor do link, o estilo do cabeçalho e a cor do texto de acordo com sua preferência.

Em seguida, basta clicar no botão “Save Changes” (Salvar alterações).

Etapa 5: Configure o feedback do artigo e as configurações de e-mail

Em seguida, você precisa mudar para a guia “Article Feedback” e marcar a opção “Enable Feedback” para permitir que os usuários avaliem seus artigos.

Você pode até mesmo adicionar um sistema de votos positivos e negativos à sua documentação do WordPress marcando essas caixas. Isso permite que os usuários digam se sua documentação ajuda a resolver os problemas deles no front-end.

Agora, clique no botão “Save Changes” (Salvar alterações) para armazenar suas configurações.

Agora, mude para a guia “Email Reports” (Relatórios por e-mail) na coluna da esquerda e marque a opção “Enable Email Reports?” (Ativar relatórios por e-mail) se quiser que o Heroic KB envie relatórios semanais sobre sua documentação.

Esse relatório incluirá o total de visualizações e a classificação média de seus artigos de documentação e exibirá até mesmo uma lista dos artigos mais bem classificados e dos mais bem classificados daquela semana.

Depois de fazer isso, adicione seu endereço de e-mail de administrador ao campo “Report Recipients”. Você pode até mesmo adicionar vários endereços de e-mail, se desejar.

Depois disso, clique no botão “Save Changes” (Salvar alterações) para armazenar suas configurações.

Agora que você definiu todas as configurações do plug-in Heroic KB, é hora de começar a criar a documentação do seu site.

Etapa 6: criar documentação para seu site WordPress

Você pode criar artigos de instruções, bases de conhecimento, guias e perguntas frequentes para sua documentação.

Para começar a criar um novo documento, acesse a página Heroic KB ” Adicionar novo artigo no painel do WordPress.

Isso abrirá o editor de conteúdo do WordPress, onde você poderá adicionar um título ao seu artigo de documentação e começar a escrever o conteúdo. Você também pode clicar no botão “+” de adicionar bloco no canto superior esquerdo para adicionar diferentes blocos ao seu conteúdo.

Depois de escrever o artigo para a documentação, você precisa expandir a guia “Categories” (Categorias) no painel de blocos e clicar no link “Add New Article Category” (Adicionar nova categoria de artigo).

Em seguida, basta criar uma categoria para o artigo que você está escrevendo.

Depois disso, expanda a seção “Tags” no painel de blocos e adicione quantas tags quiser ao seu artigo de documentação.

Você pode até mesmo adicionar um trecho do artigo expandindo a guia “Excerto”.

Em seguida, expanda a guia “Discussion” (Discussão) e desmarque a opção “Allow comments” (Permitir comentários) se quiser desativar os comentários para esse artigo. Se quiser permitir que os usuários adicionem comentários, poderá deixar essa configuração como está.

Você também pode adicionar anexos aos seus artigos na documentação. Para fazer isso, role para baixo até a seção “Opções de artigo” no editor de blocos e clique no botão “Adicionar ou carregar arquivos”.

Isso abrirá a biblioteca de mídia, na qual você poderá adicionar qualquer anexo que desejar.

Em seguida, marque a caixa “Attachments in New Window” (Anexos em nova janela) se quiser que os anexos do artigo sejam abertos em uma nova janela ao serem clicados.

Se desejar, você também pode desativar o recurso de voto positivo/voto negativo para artigos específicos, rolando a tela para baixo até a seção “Opções de votação”.

Aqui, marque a opção “Disable Voting” (Desativar votação) para desativar o sistema de upvote/downvote para esse artigo específico.

Por fim, clique no botão “Publicar” na parte superior para publicar seu artigo como documentação.

Agora, repita o processo novamente para adicionar várias entradas para sua documentação em diferentes categorias.

Depois de fazer isso, você poderá visualizar facilmente a documentação visitando a página www.example.com/knowledge-base ou a página personalizada que escolheu para a documentação.

Etapa 7: Altere a ordem dos artigos e das categorias de sua documentação

Com o Heroic KB, você também pode alterar a ordem dos artigos exibidos em sua base de conhecimento do WordPress. Para fazer isso, visite a página Heroic KB Article Ordering (Ordenação de artigos da KB Heroica) no painel do WordPress.

Aqui, escolha a categoria para a qual você deseja alterar a ordem dos artigos. Em seguida, basta arrastar e soltar os artigos para reorganizá-los de acordo com sua preferência.

Quando terminar, lembre-se de clicar no botão “Save Order” para armazenar suas configurações.

Para alterar a ordem das categorias exibidas em sua página de documentação, visite a página Heroic KB ” Category Ordering na barra lateral do administrador do WordPress.

Quando estiver lá, você poderá reorganizar a ordem das categorias arrastando-as e soltando-as. Depois de fazer as alterações, clique no botão “Save Order” para armazenar suas configurações.

Agora você criou com sucesso a documentação do seu site e alterou a categoria e a ordem dos artigos.

Bônus: adicione uma seção de perguntas frequentes ao seu site WordPress

Adicionar a documentação do WordPress é uma ótima maneira de ajudar seus usuários a encontrar as informações de que precisam. Você também pode adicionar FAQs (perguntas frequentes) junto com as publicações do blog para responder às perguntas mais comuns relacionadas ao seu conteúdo.

Isso pode aumentar o envolvimento do usuário em seu blog do WordPress e criar confiança e credibilidade com os usuários, permitindo que eles saibam que você entende as dúvidas e preocupações deles.

Além disso, as perguntas frequentes podem melhorar suas classificações de SEO, permitindo que você use palavras-chave de cauda longa que os usuários geralmente pesquisam usando mecanismos de pesquisa.

Você pode adicionar facilmente perguntas frequentes ao seu site usando o All in One SEO (AIOSEO). É o melhor plugin de SEO para WordPress do mercado que permite otimizar facilmente seu site para melhorar as classificações nos mecanismos de busca.

O AIOSEO ainda vem com um bloco de perguntas frequentes fácil de usar que pode ser adicionado diretamente ao editor de blocos, onde é possível inserir perguntas e respostas para a seção de perguntas frequentes.

O plug-in também permite personalizar a seção de perguntas frequentes a partir do painel de blocos, incluindo a cor do texto, a cor do plano de fundo, a tipografia e o invólucro do título, tornando o AIOSEO o melhor plug-in de perguntas frequentes do WordPress no mercado.

Além disso, o plug-in vem com marcação de esquema de perguntas frequentes que pode aumentar as classificações do seu site e a taxa de cliques orgânicos, fazendo com que suas perguntas frequentes apareçam diretamente nos resultados de pesquisa do Google.

Para obter instruções mais detalhadas, consulte nosso tutorial sobre como adicionar uma seção de perguntas frequentes no WordPress.

Esperamos que este artigo tenha ajudado você a aprender como adicionar documentação no WordPress. Talvez você também queira ver nosso guia para iniciantes sobre como contratar assistentes virtuais para seu site WordPress e nossas escolhas de especialistas para o melhor software de documentação técnica para WordPress.

Se você gostou deste artigo, inscreva-se em nosso canal do YouTube para receber tutoriais em vídeo sobre o WordPress. Você também pode nos encontrar no Twitter e no Facebook.