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 e ser editados para uso interno/externo.
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,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, 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,8,9….)
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 10, 11,12…)
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 com a solução somente (Imagens 13,14,15…)
