troubleshooting article preview template

Template Artigo de solução de problemas

Criado por:

Atlassian logo

Documentação e solução de problemas comuns

Categorias

  • Software e TI

Principais funções

  • Resolução de problemas

  • Documentação

  • Base de conhecimento

troubleshooting article preview template

Escreva artigos para ajudar clientes a solucionar problemas comuns e encontrar soluções por conta própria. O template de artigo de solução de problemas proporciona a estrutura necessária para você explicar o problema, detalhar a solução e exibir artigos relacionados (o que pode ser automático com o uso de etiquetas e da macro de conteúdo por etiqueta que rastreia artigos relacionados). Ensine o cliente a pescar e dê mais tempo para sua equipe de suporte fazer tarefas mais complexas.

Como usar o template de artigo de solução de problemas

  1. 1

    Descreva o problema

    É tentador pular para a solução em um artigo como esse, porém descrever o problema é uma parte muito importante da escrita de conteúdo de qualidade. Os leitores precisam saber se o artigo se refere aos problemas que estão enfrentando. Pense em como o público está passando por este problema e explique usando terminologias e exemplos relevantes a estas experiências.

  2. 2

    Dê uma solução passo a passo

    Depois de descrever o problema, é hora de explicar como ele deve ser corrigido. Usando uma lista numerada, escreva uma solução passo a passo. Use termos que os leitores conhecem e entendem e explique um passo de cada vez. Se possível, ilustre os passos com imagens. Assim, os leitores vão saber como as coisas devem se parecer em cada passo durante o percurso. Se houver mais de uma solução possível, o ideal é optar pela solução mais comum na descrição. Se achar que, de fato, você precisa oferecer mais opções, você pode usar uma opção de expansão para criar um painel que pode ser expandido com as outras soluções.

  3. 3

    Inclua artigos relacionados

    Às vezes, você encontra um artigo sobre um problema parecido com o seu, mas não igual. Às vezes, saber mais sobre como algo funciona pode ajudar você a evitar problemas futuros. Ao usar categorias nos artigos de solução de problemas e o conteúdo por macro de categoria (já incluso neste template), você exibe os artigos e páginas relacionadas na hora. Use a mesma categoria para todas as páginas relacionadas.

Templates relacionados

Parceiros

Diagrama da arquitetura AWS

Veja a infraestrutura para identificar melhor os pontos fracos e indicar as áreas que precisam de melhoria.

Documentos e relatórios

Crie sua semana de trabalho ideal

Ofereça orientação passo a passo para a conclusão de uma tarefa.

Recomendação

Runbook do DevOps

Prepare sua equipe de operações para responder com rapidez às interrupções e aos alertas do sistema.