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
|
|---|
🖥️ 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.
| Informações |
|---|
Incorreto: pois as imagens não podem ficar desfocadas e nem com a logo da empresa (Guarani) cortada (Imagem 1). |
| Dica |
|---|
Correto: aqui temos uma imagem com boa definição, apresentando a logo da empresa sem cortes e a tela completa para melhor entendimento do cliente (Imagem 2). |
🟥 Grifos de tela
As imagens inseridas nos documentos devem ser grifadas com forma geométrica retangular ou quadrada no tom vermelho e na espessura 2px ou 3px.
| Informações |
|---|
Incorreto: os destaques em tela devem seguir um padrão, não podendo ser selecionado de outra cor e nem setado (Imagem 1). |
| Dica |
|---|
Correto: 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). |
📸 - Imagens com conteúdos esmaecidos
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.
| Informações |
|---|
Incorreto: Um documento com as informações ocultadas, não pode ficar com aparência de borrão (Imagem 1). |
| Dica |
|---|
Correto: Ocultar as iformações dos clientes para que nenhum dado fique visível (Imagem 2). |
| Informações |
|---|
Incorreto: Nem mesmo sumir com as informações, pois é necessário saber que naquele campo, as informações precisam estar contidas (Imagem 3). |
| Dica |
|---|
Correto: Nesta imagem vemos como deve ser o padrão da documentação com o esmaecimento dos dados dos clientes (Imagem 4). |
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).
Informações necessárias para documentar
Para fazermos uma boa documentação, quando o ticket é de uma “Solicitação” ele deve conter sempre o relato da ocorrência e a solução, para descrevermos para o cliente.
Primeiro exemplo:
| Informações |
|---|
Incorreto: Uma 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 (Imagem 1). |
| Dica |
|---|
Correto: O resultado na nota de versão, depois de buscar dentro dos tickets atrelados com as possíveis soluções (Imagem 2). |
Segundo exemplo:
| Informações |
|---|
Incorreto: Na documentação (testers) não haviam informações suficientes para elaboração da nota de versão (Imagem 1). |
| Informações |
|---|
Documento do desenvolvedor (Imagem 2). |
| 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 (Imagem 3). |
Exemplo Ideal de Nota de versão
| Informações |
|---|
Solução Simples (Imagem 1). |
| Informações |
|---|
Solução Técnica (Imagem 2). |
| Dica |
|---|
Nota de versão ideal (Imagem 3). |
🪚 - 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).
|
|---|