El valor de agregar imágenes a la documentación técnica

El valor de agregar imágenes a la documentación técnica de V. Berba Velasco Jr

Es cliché pero verdad -- un cuadro pinta mil palabras.Esto es un mensaje importante a recordar al escribir cualquier clase de documentación del usuario, tal como una guía de la instalación o un manual de instrucción. Un documento que el uso juicioso de las marcas de imágenes y de diagramas será mucho más fácil entender que uno que se compone enteramente de descripciones del texto.

Observé hace estos años de primera mano, cuando un programador menor en una compañía fue pedido poner al día el manual de la instalación del software para sus reguladores de la máquina. Uno de las primeras cosas él debía pelar lejos todas las imágenes de la captura de pantalla, reduciendo el documento entero al texto llano. "estas imágenes son apenas tontas!" él dijo. "toman el espacio, y son no necesarios justo. Confío en que cualquier persona que lee este documento será bastante elegante calcularlo hacia fuera. "

Éste resultó ser un error enorme. Los técnicos que tuvieron que utilizar el manual tenían un rato difícil el tener de sentido de sus instrucciones.Tuvieron que pedir en varias ocasiones la clarificación, y uno de ellos me dijo que las descripciones puras del texto eran demasiado incómodas justo a seguir. Eran temerosas de usar estas instrucciones en todos, sabiendo que un solo misstep podría trabar los reguladores en un estado irrecuperable. Era una situación fea todo alrededor.

El problema era que este programador no intentó hacer cosas fáciles para los usuarios. Para una cosa, él no pudo considerar que algunos técnicos no eran personas de habla inglesa nativas, y que puede ser que luchen con la fraseología. Más importantemente sin embargo, este programador esperó también mucho de sus audiencias. Él deseó reducir estas instrucciones a su esencial pelado, pensando que sería adecuado. Él no pudo considerar que incluso un inteligente, si no el lector cuidadoso pudo ser tentado para saltar sobre instrucciones, o lustraría sobre un cierto detalle crítico.Esto es una trampa común cuando el tiempo es corto, y cuando enfrentan a los usuarios con las páginas y las páginas del texto suave.

Algunas imágenes cuidadosamente elegidas, con subtítulos convenientes, pueden ir una manera larga hacia la prevención de eso. Cuando vi eso el programador menor pelaba lejos todas las imágenes de la captura de pantalla, lo advertí contra ése. "estas imágenes pueden no ser terminantemente necesarias," I dicho, "solamente ellas ayude a clarificar a muchos de detalles. Para una cosa, demuestran a usuario exactamente qué botón a empujar, o qué ventana a seleccionar. Esto hace las instrucciones mucho más fáciles entender, y reduce la probabilidad de un error humano. "a este día, deseo que él había prestado atención a mi advertencia.

Eran los usuarios bastante inteligentes entender el manual, como él ¿demandado? Ciertamente -- pero la inteligencia no es ninguna garantía contra error humano. ¿Se habrían podido las imágenes interpretar como hablando abajo con el usuario?Quizás -- pero en mi experiencia, los usuarios sofisticados responden raramente esa manera. Algo, la mayoría de ellos se parecen entender el valor que estas imágenes traen a la tabla. Quizás está porque la mayoría de ellos saben que como cuáles debe ser frazzled y presionó por tiempo, y los detalles importantes se pueden perder fácilmente en el texto.

Recuerde tan -- un cuadro pinta mil palabras, y un solo la captura de pantalla puede valer más que las páginas una docena del texto. Es una lección que está digno de aprender.

Sobre El Autor V Berba Velasco Jr. tiene un doctorado en la ingeniería eléctrica y ha estado practicando su comercio por casi una década. Durante ese tiempo, él ha encontrado en varias ocasiones que las buenas habilidades técnicas de la escritura son casi tan críticas como buenas habilidades de ingeniería. Dr. Velasco trabaja actualmente como Software Engineer eléctrica y mayorpara la tecnología celular limitada ( http://www. immunospot. COM ), una compañía del biotech en Cleveland, Ohio. (la otra escritura y artículo relacionaron términos de la búsqueda: escritura del diario, escritura técnica en línea)

Other Writing News on the Internet

Artículos Relacionados en el anecdote. org