Um artigo baseado num pedido técnico resolvido descreve um sintoma, ambiente verificado, solução testada e confirmação do resultado. Remova dados do cliente e limite os passos às condições comprovadas.
Escolher um caso reproduzível
Confirme causa, solução e resultado. Encerrar um pedido não prova sucesso. Sem teste ou confirmação do cliente, não apresente instruções como verificadas.
Escolha um sintoma. Não junte problemas diferentes por terem a mesma equipa de apoio.
Anonimizar os materiais
Retire nomes, moradas, documentos privados, números de conta, identificadores de sessão e segredos técnicos. Inspecione imagens separadamente.
Mantenha factos necessários sobre produto, versão, ambiente, sintoma e condição desencadeante. Descreva configurações identificáveis com segurança, preservando a causa. Não publique a correspondência.
Estruturar sintoma–ambiente–solução
- Sintoma: o que se observa e quando.
- Ambiente: produto, versão, sistema e configuração relevante.
- Condição de correspondência: como reconhecer o caso aplicável.
- Solução: passos testados neste caso.
- Verificação: resultado esperado.
- Limites e escalada: quando parar ou contactar apoio.
Diagnóstico não é reparação. Recolher dados não é solucionar. Para proteger informação, remeta para o procedimento confirmado do produto.
Exemplo fictício
Não é uma falha do Semly. Numa aplicação documental 2.4.0, uma lista aberta não mostra um novo documento após uma alteração confirmada de permissões. Recarregar atualiza a lista, não as permissões.
A sessão começou antes da alteração. O documento deve aparecer numa vista recém-aberta para a mesma conta.
Guarde trabalho não gravado e recarregue segundo as instruções reais da aplicação. Verifique se o documento aparece e abre com a permissão correta. Se faltar também na nova vista, o caso não está confirmado e precisa de outro diagnóstico.
Explicar limites
Liste apenas versões e configurações testadas. Interfaces parecidas não comprovam suporte noutra plataforma.
Não prometa que recarregar corrige permissões ou dados ausentes. Outras causas exigem outros procedimentos. A condição evita repetir passos irrelevantes.
Testar como utilizador
Um revisor técnico reproduz o caso com segurança e segue o texto sem conhecer o pedido. Condições e sucesso devem ser explícitos.
Complete dados em falta sobre ambiente e aplicabilidade. O artigo não pode depender de conhecimento exclusivo do autor.
Registar revisão e tradução
Guarde data e responsável. Depois de mudanças do produto, reveja condições e passos.
As traduções mantêm versão, sintoma, sequência e critério de sucesso. As mensagens correspondem à interface real. Outra causa e solução constituem outro caso, não um apêndice desligado.
