segunda-feira, 10 de abril de 2017

10 Cuidados ao Utilizar Imagens em Documento Técnico

A utilização de imagens em documentos técnicos apresenta grandes desafios independentemente do formato de apresentação do documento, seja impresso, em arquivo, em um site, em um celular ou tablet.

Na grande maioria dos documentos técnicos existem várias imagens para facilitar a compreensão do texto. Uma imagem pode simplificar o entendimento de determinado processo ou mesmo facilitar a localização de algum recurso.

seleção de imagem


Neste post vou listar alguns desafios e cuidados que devemos ter ao utilizar imagens em documento técnico.

1. Armazenamento dos Arquivos de Imagem

Quando escrevemos um documento técnico, por exemplo, um manual de usuário de um aplicativo, podemos capturar as imagens das telas e ir “colando” diretamente no documento, sem se preocupar em armazenar estas imagens para edição posterior. Se o aplicativo sofrer alterações podemos capturar a imagem novamente e refazer o processo, por isto às vezes não pensamos em armazenar a imagem em um local separado.

Mas e se precisarmos da imagem novamente para utilizar em outro documento, ou se precisarmos de partes da imagem para fazer um passo a passo. Este é somente um exemplo que indica a importância de armazenar em um local separado todas as imagens utilizadas no documento.

2. Utilizar Imagens Vetoriais x Não Vetoriais

Podemos dividir os tipos de imagens utilizados em documentos técnicos como vetoriais e não vetoriais.

As imagens vetoriais são compostas por pontos, linhas, formas, polígonos entre outros elementos os quais são baseados em expressões matemáticas. Este tipo de imagem por ser baseada em vetores são mais leve e podem ser ampliadas e reduzidas sem perder a qualidade. Um exemplo de imagem vetorial utilizada em navegadores e recomendada pela W3C é o formato SVG (Scalable Vector Graphics). O formato SVG utiliza a linguagem XML para descrever de forma vetorial desenhos e gráficos.

As imagens não vetoriais são compostas por pontos diferenciados por sua cor. Podemos citar como imagens não vetoriais mais comuns as imagens com formato JPG, BMP, PNG, GIF entre outras. Estas imagens possuem um tamanho de arquivo maior e perdem a qualidade quando redimensionadas.

Uma situação comum que acontece em documentos técnicos são as atualizações do produto, processo ou aplicativo. Nestes casos a imagem precisa ser atualizada. É neste momento que vemos a importância de utilizar imagens vetoriais, quando possível. Nem sempre é possível utilizar imagens vetoriais como, por exemplo, em manuais de software. Nestes casos as imagens são capturas das telas do aplicativo, que são gravadas em formato não vetorial.

Para as imagens não vetoriais a substituição é o mais comum, às vezes é possível alterar a imagem dependendo das modificações do aplicativo, mas redimensionamento da imagem pode ser um problema, já que a cada vez que redimensionamos a imagem, ela perde a qualidade, principalmente o formato JPG.

Para as imagens vetoriais podemos fazer as alterações necessárias diretamente na imagem e gerar a imagem final alterada em diversos formatos e dimensões, sem a perda da qualidade da imagem.

Portanto um cuidado que podemos ter é utilizar, quando possível, imagem vetorial e a partir destas imagens gerar o não vetorial para os diversos tipos de publicações.

3. Imagens Utilizadas como Referência

Em alguns tipos de plataformas onde são apresentados os documentos técnicos, como navegadores que utilizam HTML ou documentos desenvolvidos com DITA, não permitem a inserção direta da imagem e sim uma referência do local onde está a imagem.

Neste formato de documentação é necessário ter muito cuidado para controlar o local das imagens. As atualizações das imagens não são feitas no documento e sim diretamente no arquivo da imagem, por este motivo o controle da localização da imagem é muito importante para evitar problemas como exibir a imagem correta, ou não exibir nenhuma imagem, porque o arquivo foi retirado ou alterado de sua localização original.

4. Publicação das Imagens

Cada plataforma de publicação de documento com imagens pode aceitar somente alguns formatos específicos de imagem, por exemplo, o formato SVG é relativamente novo e, por exemplo, no caso do Internet Explorer funciona somente a partir de versão 9. Se você precisa publicar em plataformas mais antigas ou mesmo plataformas que não aceitam este formato, é necessário converter a imagem em outros formatos como, por exemplo, JPG ou PNG.

Portanto é sempre bom ter a mesma imagem em vários formatos para o caso de publicar o documento em diferentes plataformas.

5. Reuso da Mesma Imagem

Utilizar a mesma imagem para explicar situações diferentes é tentador, mas o usuário pode ficar confuso se a imagem possuir muitos detalhes que não são relevantes ao contexto em questão. Mesmo que existam setas ou outras indicações o usuário pode não entender. Nestes casos o melhor é cortar a imagem e exibir somente a parte relevante ao assunto. Os usuários estão mais propensos a perdoar um detalhe irrelevante que está faltando, do que visualizar muitos detalhes que não existem em sua aplicação e causar dúvidas na utilização.

6. Controle de Versão de Imagem

Em um documento técnico que possui controle de versão, as imagens existentes no documento não são controladas da mesma forma como o texto, portanto não dá para saber qual a versão de imagem está no documento.

Para controlar a versão da imagem pode-se utilizar um aplicativo de controle de versão normal, mas as imagens vão ter que ter o seu próprio controle de versão, independente do documento. No caso de imagens de manual de usuário possuir as várias versões das imagens pode ser útil para identificar as diferentes versões do aplicativo e possível evolução do mesmo.

7. Tamanho da Imagem

O tamanho e resolução da imagem são importantes tanto no documento como no ambiente de publicação. Quando estamos trabalhando com a ferramenta de criação e edição de imagem não existe uma preocupação com o tamanho final da imagem, porque queremos obter uma imagem com a melhor resolução possível, mas dependendo do documento e de onde o documento vai ser publicado torna-se necessário tomar alguns cuidados.

Por exemplo, inserir documentos com alta resolução e com o tamanho do arquivo muito grande em documentos Word, pode ser um problema. Primeiro o arquivo Word final vai ficar com um tamanho muito grande dificultando o manuseio do arquivo e armazenamento, sem falar na dificuldade de enviar o arquivo para revisão em outros departamentos.

Se a publicação final for um documento impresso em impressora comum, não é necessário que as imagens sejam em alta resolução, porque a impressora não vai reproduzir toda a resolução. Se for um documento PDF o tamanho da imagem também é importante para não termos um arquivo muito grande.

Se a publicação for feita na internet, temos o problema de velocidade e quantia de bytes necessários para fazer o download e exibir a imagem, portanto neste caso também não é necessário termos figuras com uma resolução muito alta.

De uma forma geral após a elaboração da imagem é necessário verificar onde vai ser publicada para decidir o tamanho e resolução finais da imagem.

8. Atualização de Imagens

A atualização de imagens podem seguir dois processos diferentes, dependendo de como foi utilizada no documento. No caso da imagem estar inserida diretamente no documento a atualização de imagem é bem trabalhoso, porque é necessário alterar cada imagem no documento.

No caso de documentos que possuem a referência da imagem pode ser um pouco menos trabalhoso, porque precisamos alterar a imagem somente no local físico. Como o documento possui uma referência, ele acaba sempre exibindo a imagem mais atualizada, se existir um processo bem definido de atualização destas imagens.

9. Controle de Qualidade das Imagens no Documento 

O controle de qualidade das imagens no documento é muito importante para garantir a qualidade final, por isto sempre verifique todas as imagens inseridas no documento, e em todas as plataformas de publicação. Às vezes algum formato não exibe corretamente em determinada plataforma, ou pior no caso de inserirmos somente a referência da imagem, é importante verificar a exibição da imagem, se ficou com uma boa qualidade e se a referência está correta.

10. Tradução de Texto em Imagens

Um problema comum em documentos é a utilização do documento em várias línguas. Neste caso o documento deve passar pelo processo de tradução, mas e as imagens como ficam?

Se a imagem possui texto no caso de um documento que deve ser feito em várias línguas, gera um problema, porque é necessário fazer a tradução do texto das imagens e depois alterar a imagem para inserir o texto. Neste caso podemos ter uma imagem para cada língua do documento.

Uma forma de minimizar este problema é procurar trabalhar com imagens com pouco ou sem texto se possível, ou se for necessário indicar alguma informação textual, podemos indicar a informação com números e criar uma tabela que referencia o número com o texto.

Conclusão


Para elaborar um documento técnico dependendo da aplicação, além do conteúdo em termos de texto é necessário fazer um bom planejamento sobre o a criação e gerenciamento das imagens, porque as imagens são parte importante do bom resultado da usabilidade do documento.

Posts Relacionados:


Referência