| Índice | ||||
|---|---|---|---|---|
|
...
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 testes prints de telas com boa definição (Imagens 1, 2 e 3).
...
...
...
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 . 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).
...
...
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).
|
|---|