Introdução
Aqui, forneceremos algumas diretrizes sobre como padronizar a documentação para uso dos departamentos responsáveis na edição das “Notas de versão”, bem como “Manuais” e outros documentos que possam ser editados para uso interno/externo. |
|---|
Índice
| Índice |
|---|
| minLevel | 2 |
|---|
| maxLevel | 2 |
|---|
| indent | 10px |
|---|
| printable | false |
|---|
|
|
|---|
🖥️ 1. Prints de tela
Nas documentações não podem haver prints de vídeo, desta forma devemos ter dentro dos documentos feitos pelos testers/desenvolvedores, prints de telas com boa definição.
Exemplo 1.1
| Aviso |
|---|
Incorreto: A imagem não pode ficar desfocada, com o nome de tela e nem a logo da empresa (Guarani) cortada. |
| Dica |
|---|
Correto: Imagem com boa definição, apresentando logo da empresa sem cortes e a tela completa para melhor entendimento. |
🟥 2. Grifos de tela
As imagens inseridas nos documentos devem ser grifadas com formas geométricas retangular ou quadrada no tom vermelho e na espessura 2px ou 3px. Não podem haver setas nas imagens para destacar nenhum campo específico.
Exemplo 2.1
| Aviso |
|---|
Incorreto:Destaques em tela, não podem ser selecionados de outra cor e nem setados. |
| Dica |
|---|
Correto:Os pontos destacados estão na cor padrão e não há setas na imagem. |
📸 3. Imagens com conteúdos esmaecidos
| Nota |
|---|
Foi combinado com Marina Mattos que serão usadas bases teste com dados genéricos. Sendo assim, não é necessário esmaecer nenhum dado. |
Caso seja necessário, seguem instruções para o correto uso do efeito de esmaecimento.
Para ocultarmos as informações dos clientes, é necessário que isso seja feito de uma forma que esteticamente não fique fora do padrão. Trabalhamos com o efeito de esmaecimento do ShareX, pois é possível sua configuração com um único click esmaecer as informações dos clientes. É necessário utilizar o efeito blur para esmaecer.
| Aviso |
|---|
Proibido usar o PicPick pois ele não cumpre com a lei LGPD. |
Exemplo 3.1
| Aviso |
|---|
Incorreto: Documento com as informações ocultadas, não pode ficar com aparência de borrão ou pixelizado. Sendo assim, o excesso de esmaecimento não cabe. |
| Dica |
|---|
Correto:Ocultando Deveráocultar todas as iformações informações dos clientes para que nenhum dado fique visível e apresentável., mas de forma apresentável. |
| Aviso |
|---|
Incorreto: Não podem sumir as informações contidas nos campos, pois é necessário saber do seu preenchimento. |
| Dica |
|---|
Correto:Nesta imagem, vemos como devem os ocultamentos dos exemplificamos a forma no qual devem ser ocultados os dados dos clientes. |
Exemplo de como não esmaecer:  Image Added
|
|---|
💬 : Imagens esmaecidas desta forma os tickets serão devolvidos. |
|---|
4. Textos dentro das imagens
Não colocar indicações, textos ou explicações por escrito dentro da imagem selecionada para a documentação.
Exemplo 4.1
| Aviso |
|---|
Incorreto: Colocar Não colocar observações e ou apontamentos dentro dos prints. |
| Dica |
|---|
Correto: Manter as imagens com boa resolução e sem poluição visual. |
?? - Sistema print
Quando houverem telas de duas situações lado a lado, não colar uma sobre a outra, fazer separadamente as imagens.
Image Removed
Image Removed
Image Removed
Para fazermos uma boa documentação, quando o ticket é de for uma “Solicitação” ele deve deverá conter sempre o relato da ocorrência e a solução, para descrevermos para o cliente.
Primeiro exemplo:Exemplo 5.1
 Image Modified |
Uma documentação Documentação onde não há o relato da ocorrência e na solução, não ficou explicado o que foi ajustado |
|
para descrevermos para o cliente |
 Image Modified |
O resultado Resultado na nota de versão, depois de |
|
buscar buscarmos dentro dos tickets atrelados, as possíveis soluções. |
|
Exemplo 5.2
 Image Modified| Aviso |
|---|
Incorreto: Na documentação (testers), não haviam informações suficientes para elaboração da nota de versão. |
|
 Image Modified
|
Documento No documento do desenvolvedor, haviam informações para uma possível documentação da nota de versão. |
 Image Modified
| Dica |
|---|
Correto: Foi utilizada a documentação do desenvolvedor para a solução, mas foi uma publicação com a limitação de informações. |
|
6. Exemplo Ideal de Nota de
versãoVersão
 Image Modified Image Modified
|
Documentação exemplar contendo Para documentarmos devidamente, é necessário que o ticket contenha a Solução Simples (Testers) e Solução Técnica (Desenvolvedor). |
|
 Image Modified
|
Nota Desta forma, conseguimos elaborar uma “Nota de versão |
|
ideal
| Índice |
|---|
| minLevel | 2 |
|---|
| maxLevel | 2 |
|---|
| type | flat |
|---|
| printable | false |
|---|
|
|
|---|
📣 Deixe seu feedback
Essa documentação foi útil pra vc? Comente embaixo.