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 testes testers/desenvolvedores, prints de telas com boa definição (Imagens 1, 2 e 3).
.
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 forma geométrica formas geométricas retangular ou quadrada no tom vermelho e na espessura 2px ou 3px .
| Nota |
|---|
Nos dados dos clientes, eles devem ser manchados e não pintados (Imagens 4, 5 e 6). |
⌨️ - Textos
Nas explicações sobre o que foi feito em cada ticket, não tem necessidade de concordância verbal e correções gramaticais, pois isso é feito pelo setor de documentação (Imagens 7 e 8).
- 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).
. 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: Deveráocultar todas as informações dos clientes para que nenhum dado fique visível, mas de forma apresentável. |
Exemplo 3.2
| Aviso |
|---|
Incorreto: Não podem sumir as informações contidas nos campos, pois é necessário saber do seu preenchimento. |
| Dica |
|---|
Correto:Nesta imagem, exemplificamos a forma no qual devem ser ocultados os dados dos clientes. |
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.