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
|
|---|
🖥️
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
| Informaçõeswarning |
|---|
Incorreto: pois as imagens não podem ficar desfocadas e nem com A imagem não pode ficar desfocada, com o nome de tela e nem a logo da empresa (Guarani) cortada(Imagem 1). |
| Dica |
|---|
Correto: aqui temos uma imagem Imagem com boa definição, apresentando a logo da empresa sem cortes e a tela completa para melhor entendimento do cliente (Imagem 2). |
. |
2. Grifos de tela
As imagens inseridas nos documentos devem ser grifadas com forma geométrica 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:os destaques Destaques em tela devem seguir um padrão, não podendo podem ser selecionado selecionados de outra cor e nem setado (Imagem 1)setados. |
| Dica |
|---|
Correto: os Os pontos destacados estão na cor padrão e não há setas na imagem, este deve ser um m odelo a ser seguido (Imagem 2). |
. |
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: Um documento Documento com as informações ocultadas, não pode ficar com aparência de borrão (Imagem 1). |
ou pixelizado. Sendo assim, o excesso de esmaecimento não cabe. |
| Dica |
|---|
Correto:Ocultar Deveráocultar todas as iformações informações dos clientes para que nenhum dado fique visível (Imagem 2). |
, mas de forma apresentável. |
Exemplo 3.2
| Aviso |
|---|
Incorreto: Nem mesmo Não podem sumir com as informações contidas nos campos, pois é necessário saber que naquele campo, as informações precisam estar contidas (Imagem 3)do seu preenchimento. |
| Dica |
|---|
Correto:Nesta imagem vemos como deve ser o padrão da documentação com o esmaecimento dos , exemplificamos a forma no qual devem ser ocultados os dados dos clientes (Imagem 4). |
- Melhoria ou mudanças
Quando se refere a melhorias ou mudanças, é necessário que inicie com o número da tela. Tomamos como exemplo: Na tela xxx - gdgfsfsfsf, foi implementado……. (Imagens 9, 10 e 11).
- Solicitação
Quando for um ticket sobre uma solicitação feita, será necessário colocar o problema e a solução, uma breve descrição, bem como uma imagem somente com a solução (Imagens 12, 13 e 14).
🪚 - Sistema print
Quando houverem telas de antes e depois ou colocar duas situações lado a lado, não colar uma sobre a outra, fazer separadamente as imagens (Imagens 15, 16 e 17).
🔀 - Imagens com setas
Quando fizer as imagens só a circulação do conteúdo com grifo vermelho já será o suficiente, pois para evitar poluição visual é melhor que não coloquem setas (Imagens 18 e 19).
💬 - Textos dentro das imagens
Não colocar indicações, textos ou explicações por escrito dentro da imagem selecionada para a documentação (Imagem 20).
. |
Exemplo de como não esmaecer:
Obs.: 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: 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. |
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
| ||
|
|
|---|
| Rv macro | ||
|---|---|---|
|
📣 Deixe seu feedback
Essa documentação foi útil pra vc? Comente embaixo.