Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.55 KB

troubleshooting.md

File metadata and controls

35 lines (22 loc) · 1.55 KB

Modelo de Troubleshooting

Contexto

O Troubleshooting é uma documentação focada em listar possíveis erros que um produto, serviço ou funcionalidade pode apresentar e como solucionar este problema. É também chamada de documentação de erros ou de resolução de problemas.

Algumas orientações para escrever um troubleshooting de acordo com o guia do The Good Docs Project:

  • Certifique-se de que você testou o produto/solução para ver se está funcionando corretamente
  • Identifique todos os cenários de erro
  • Mapeie as soluções para cada cenário encontrado
  • Organize seu documento em sintomas/causas e soluções

Exemplo de documentação

Troubleshooting FireBank

1. Erro ao acessar sua conta

Devido a instabilidades de processamento de dados, pode acontecer de você tentar realizar o login na sua conta e não conseguir.

Soluções

  1. Redefina sua senha
  2. Recarregue a página

Caso o erro persista, verifique se sua conexão à internet está funcionando ou entre em contato pelo Firebot ou telefone da Central de Atendimento: (61) 99999-9999.

Links relacionados