Excelente Redação Técnica Melhora o Acesso dos Leitores com um Índice Visual

As pessoas são criaturas visuais. Eles olham para o seu produto e veem, por exemplo, um botão ou display. Eles querem saber mais sobre esse controle ou indicador. Um índice visual é uma ferramenta de acesso a documentos simples, mas poderosa, que permite que seus leitores encontrem as informações que desejam.

Este artigo descreve o conceito de índice visual e informa como criar um para o seu documento.

ÍNDICE VISUAL

Um índice visual é uma imagem do seu produto ou processo com links para as informações relevantes no documento relacionado. Usando um índice visual, seus leitores podem olhar a imagem e pular rapidamente para o local em seu documento que descreve o item de interesse.

Seu documento pode incluir vários índices visuais (o plural de “índice ‘é“ índices ”e não“ índices ”).

COMEÇA COM UMA IMAGEM

O Índice Visual começa com uma imagem do seu produto ou processo. Existem vários tipos de imagens para usar, com base no tipo de produto:

• Produto físico (por exemplo, um churrasco ou gravador de disco de vídeo)

Imagens do produto (todas as visualizações relevantes).

• Um procedimento ou processo: um fluxograma das etapas e decisões no procedimento ou processo.
• Produto de software 1: Capturas de tela do software.
• Produto de Software 2: Imagens antes e depois do trabalho que o produto realiza.
• Organização: um organograma.

ROTULE A IMAGEM

Identifique todos os pontos de interação usuário-produto (U-PIP) na imagem. Um U-PIP é qualquer lugar em que seu usuário e o produto possam interagir. Os U-PIPs incluem controles, visores e recursos físicos relevantes do produto (como alças, travas, etc.). Forneça uma etiqueta (nome) significativa (para o seu leitor) para o U-PIP. (Use a mesma etiqueta exata em todos os lugares que você referir a esse U-PIP.) A parte

: Se o seu produto usa sons para informar o usuário, inclua uma tabela desses sons, o que eles significam e um link para a área relevante do seu documento (descrevendo o som).

LIGUE OS U-PIPs AO SEU DOCUMENTO

Até este ponto, o Índice Visual é como qualquer imagem bem identificada de seu produto ou processo. No entanto, quando você adiciona links ao seu documento, a imagem bem identificada se torna um Índice Visual.

O link deve direcionar para uma seção do documento que você acredita que o leitor mais gostaria de acessar para obter as informações sobre esse U-PIP. (Esta é uma questão fundamental sempre que você cria um índice: “meu leitor deseja ir a este lugar em meu documento para este item?”)

Seu método de adicionar links à imagem depende do mecanismo de publicação do documento. Se o documento for publicado como:

• Um documento impresso, use números de página para os links;
• Um Documento Eletrônico, então use hiperlinks nos quais um Leitor pode clicar para seguir. Se o documento for publicado como HTML, o índice visual pode ser um mapa de imagens.

EXEMPLO 1: UMA DOR NO MEU PÉ

Sinto uma dor no pé quando caminho. Se eu for a um site sobre pés, seria muito eficiente para descobrir sobre minha dor, se eu pudesse ver a foto de um pé com várias áreas onde a dor pode estar. Links das áreas dos pés para páginas da web específicas me permitiriam encontrar rapidamente as informações sobre minha dor específica no pé.

EXEMPLO 2: SOFTWARE DE CORREÇÃO DE FOTOS

Mostre uma imagem com os erros que seu software pode tratar, antes e depois da correção. Aqui, os U-PIPs são cada um dos erros das fotos.

EXEMPLO 3: UM CURSO DE ESCRITA DA DOCUMENTAÇÃO DO USUÁRIO

O Índice Visual é um fluxograma para a criação do Documento do Usuário. Como o Curso é apresentado em HTML, o Índice Visual é feito a partir de um mapa de imagem, com hiperlinks para as seções do Curso relevantes para cada item do fluxograma.

Um índice visual é um conceito simples. Mas, como muitos conceitos simples, é muito poderoso. Tente incluir um em seu próximo documento. Você estará prestando um grande serviço ao seu Reader.