Orientações para padrão de documentação

Owned by Luciana Barboza
Last updated: dez. 17, 2024
4 min read

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.

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.

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

Incorreto: A imagem não pode ficar desfocada, com o nome de tela e nem a logo da empresa (Guarani) cortada.

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

Incorreto: Destaques em tela, não podem ser selecionados de outra cor e nem setados.

3. Imagens com conteúdos esmaecidos

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.

Exemplo 3.1

Exemplo 3.2

 

Exemplo de como não esmaecer:

 

 

Exemplo de como não esmaecer:

 

 

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

 

5. Informações necessárias para documentar

Para fazermos uma boa documentação, quando o ticket for uma “Solicitação” ele deverá conter sempre o relato da ocorrência e a solução.

Exemplo 5.1

Exemplo 5.2

 

 

6. Exemplo Ideal de Nota de Versão

 

 

 

[ 1 1. Prints de tela ] [ 2 2. Grifos de tela ] [ 3 3. Imagens com conteúdos esmaecidos ] [ 4 4. Textos dentro das imagens ] [ 5 5. Informações necessárias para documentar ] [ 6 6. Exemplo Ideal de Nota de Versão ]
[ 1 1. Prints de tela ] [ 2 2. Grifos de tela ] [ 3 3. Imagens com conteúdos esmaecidos ] [ 4 4. Textos dentro das imagens ] [ 5 5. Informações necessárias para documentar ] [ 6 6. Exemplo Ideal de Nota de Versão ]

 

Deixe seu feedback

Essa documentação foi útil pra vc? Comente embaixo.