Close

Categorias

Template do artigo de solução de problemas

por Atlassian

Document common problems and how to solve them

Usar template
Template do artigo de solução de problemas

Ajude os clientes a solucionar problemas comuns e encontrar soluções sozinhos escrevendo artigos de solução de problemas. O template de artigo de solução de problemas proporciona a estrutura necessária para articular o item, especificar a solução e exibir artigos relacionados (que você pode fazer na hora usando categorias e a macro de conteúdo por categoria para monitorar os artigos relacionados). Mostre como devem se virar e dê mais tempo para a equipe resolver tarefas mais complexas.

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

Etapa 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.

Etapa 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.

Etapa 2. Dê uma solução passo a passo

Etapa 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.


A Atlassian é uma empresa de software corporativo que desenvolve produtos para desenvolvedores de software, gerentes de projeto e gestão de conteúdo.

  • AWS architecture diagram template

    Lucidchart

    Diagrama da arquitetura AWS

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

  • DevOps runbook template

    Atlassian

    Runbook do DevOps

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

  • DevOps change management template

    Atlassian

    Gerenciamento de mudanças do DevOps

    Use este template para avaliar o desempenho do gerenciamento de mudanças e reduzir os riscos.