Gran escritura técnica: Mejorar el acceso de los lectores con un índice Visual

Un índice Visual es una imagen de su producto o proceso con enlaces a...






Palabras clave:


escritura técnica, acceso a los documentos, índice, índice visual






Cuerpo del artículo:


VISIÓN GENERAL




Las personas son criaturas visuales. Miran su producto y ver, por ejemplo, un botón o una pantalla. Quieren saber sobre ese control o indicador. Un índice Visual es una herramienta de acceso del documento simple pero potente que permite a los lectores a encontrar la información que desean.




Este artículo describe el concepto de índice Visual y le indica cómo crear uno para el documento.




UN ÍNDICE VISUAL




Un índice Visual es una imagen de su producto o proceso con vínculos a la información pertinente en el documento relacionado. Utilizando un índice Visual, los lectores pueden mirar la imagen y saltar rápidamente al lugar en el documento que describe el elemento de interés.




El documento puede incluir varios índices Visual (el plural de "índice" es "índices" no "índices").




COMIENZA CON UNA IMAGEN




El índice Visual comienza con una imagen de su producto o proceso. Hay varios tipos de imágenes para utilizar, en función del tipo de producto:




* Física producto (por ejemplo, una barbacoa o video grabador de disco)


Imágenes del producto (todas las opiniones pertinentes).




* Un procedimiento o proceso: un diagrama de flujo de las medidas y decisiones en el proceso o procedimiento.




* Software producto 1: Imágenes del software.




* Software producto 2: Antes y después de imágenes de la obra que el producto no.




* Organización: Un organigrama.




LA IMAGEN DE LA ETIQUETA




Etiquetar todos los productos de usuario interacción puntos (U-PIP) en la imagen. Un U-PIP es en cualquier lugar que el producto y el usuario pueden interactuar. U-PIP incluye controles y muestra las características físicas del producto (por ejemplo, controladores, cerraduras, etc.). Proporcionar una etiqueta descriptiva (para el lector) (nombre) para el U-PIP. (Utilice que exacta misma etiqueta en todas partes que se hace referencia a U-PIP).




Además: Si el producto utiliza sonidos para informar al usuario, entonces incluir una tabla de los sonidos, lo que significan y un vínculo en el área relevante de su documento (que se describe el sonido).




VINCULAR el U PIP al documento




Hasta este punto, el índice Visual es igual a cualquier imagen well-labeled de su producto o proceso. Sin embargo, al agregar vínculos en el documento, la imagen de well-labeled se convierte en un índice Visual.




El vínculo debe ser una sección del documento que crees que tu lector más desea llegar a obtener la información sobre ese U-PIP. (Esto es una cuestión fundamental cuando se crea un índice: "mi lector quiere venir a este lugar en mi documento de este artículo?")




Su método para agregar vínculos a la imagen depende el mecanismo de publicación para el documento. Si el documento es publicado como:




* Un documento impreso y, a continuación, usar números de página para los vínculos;




* Un documento electrónico, a continuación, usar hipervínculos que un lector puede hacer clic a continuación. Si el documento se publica como HTML, el índice visual puede ser un mapa de imagen.




EJEMPLO 1: UN DOLOR EN MI PIE




Tengo un dolor en mi pie al caminar. Si voy a un sitio Web sobre pies, sería muy eficaz para conocer mi dolor, pude ver una foto de un pie con diversas áreas donde podría ser el dolor. Enlaces de las zonas de pie para páginas web específicas permitiría me encontrar la información sobre mi dolor en el pie específicos rápidamente.




EJEMPLO 2: FOTO CORREGIR SOFTWARE




Mostrar una imagen con los errores que puede manejar su software, antes y después de la corrección. Aquí el U PIP es cada uno de los errores de la foto.




EJEMPLO 3: UN CURSO SOBRE LA DOCUMENTACIÓN DE USUARIO DE ESCRITURA




El índice Visual es un diagrama de flujo para crear el documento de usuario. Dado que el curso se presenta en HTML, el índice Visual está hecho de un mapa de imagen, con hipervínculos en las secciones del curso correspondiente a cada elemento del diagrama de flujo.




LÍNEA INFERIOR




Un índice Visual es un concepto simple. Pero como muchos conceptos simples es muy poderosa. Tratar de incluir en el documento siguiente. Se va a realizar a su lector un gran servicio.