O valor de adicionar imagens à documentação técnica
| by V. Berba Velasco Jr. | October 19, 2004
É cliché, mas o retrato verdadeiro-um pinta mil palavras. Esta é uma mensagem importante a recordar ao escrever toda a sorte da documentação do usuário, tal como uma guia da instalação ou um manual de instrução. Um original que o uso judicious dos makes das imagens e dos diagramas seja muito mais fácil de compreender do que um que é composto inteiramente de descrições do texto.
Eu observei estes anos first-hand há, quando um programador júnior em uma companhia foi pedido para atualizar o manual da instalação do software para seus controladores da máquina. Uma das primeiras coisas que era descascar afastado todas as imagens da captação de tela, reduzindo o original inteiro ao texto liso. “Estas imagens são apenas silly!” disse. “Fazem exame acima do espaço, e são nao necessários justo. Eu confío em que qualquer um que lê este original será esperto bastante o figurar para fora.”
Isto girou para fora para ser um erro enorme. Os técnicos que tiveram que usar o manual tiveram uma estadia difícil fazer o sentido de suas instruções. Tiveram que repetidamente pedir esclarecimento, e um deles disse-me que as descrições puras do texto eram demasiado incómodas justo a seguir. Eram temível de usar estas instruções em tudo, sabendo que um único misstep poderia travar os controladores em um estado irrecuperável. Era uma situação feia toda ao redor.
O problema era que este programador não tentou fazer coisas fáceis para os usuários. Para uma coisa, não considerou que alguns técnicos não eram altofalantes ingleses nativos, e que puderam se esforçar com o fraseio. Mais importante though, este programador esperou demasiado de suas audiências. Quis reduzir estas instruções a seus fundamentos desencapados, pensando que seriam adequados. Não considerou que mesmo um inteligente, se não o leitor cuidadoso pôde tempted saltar sobre instruções, ou anotou sobre algum detalhe crítico. Este é um pitfall comum quando o tempo é curto, e quando os usuários estão confrontados com as páginas e as páginas do texto bland.
Algumas imagens com cuidado escolhidas, com subtítulos apropriados, podem ir uma maneira longa para impedir isso. Quando eu vi que o programador júnior descascava afastado todas as imagens da captação de tela, eu adverti-o de encontro àquele. “Estas imagens não podem ser estritamente necessárias,” I dito, “mas elas ajudar esclarecer muitos dos detalhes. Para uma coisa, mostram ao usuário exatamente que tecla a empurrar, ou que janela a selecionar. Isto faz as instruções muito mais fáceis de compreender, e reduz a probabilidade de um erro humano.” A este dia, eu desejo que heeded meu aviso.
Os usuários inteligentes bastante para compreender o manual, como ele foram reivindicados? Certo-mas a inteligência não é nenhuma garantia de encontro ao erro humano. Poderiam as imagens ter sido interpretadas como falando para baixo ao usuário? Talvez-mas em minha experiência, os usuários sofisticados respondem raramente essa maneira. Rather, a maioria deles parecem compreender o valor que estas imagens trazem à tabela. Talvez é porque a maioria deles sabem que o que é como ser frazzled e pressionou por o tempo, e fàcilmente os detalhes importantes podem ser perdidos no texto.
Recordar-um assim pinturas do retrato mil palavras, e uma única captação de tela pode valer a pena mais do que as páginas uma dúzia do texto. É uma lição que valha a pena aprender.
Eu observei estes anos first-hand há, quando um programador júnior em uma companhia foi pedido para atualizar o manual da instalação do software para seus controladores da máquina. Uma das primeiras coisas que era descascar afastado todas as imagens da captação de tela, reduzindo o original inteiro ao texto liso. “Estas imagens são apenas silly!” disse. “Fazem exame acima do espaço, e são nao necessários justo. Eu confío em que qualquer um que lê este original será esperto bastante o figurar para fora.”
Isto girou para fora para ser um erro enorme. Os técnicos que tiveram que usar o manual tiveram uma estadia difícil fazer o sentido de suas instruções. Tiveram que repetidamente pedir esclarecimento, e um deles disse-me que as descrições puras do texto eram demasiado incómodas justo a seguir. Eram temível de usar estas instruções em tudo, sabendo que um único misstep poderia travar os controladores em um estado irrecuperável. Era uma situação feia toda ao redor.
O problema era que este programador não tentou fazer coisas fáceis para os usuários. Para uma coisa, não considerou que alguns técnicos não eram altofalantes ingleses nativos, e que puderam se esforçar com o fraseio. Mais importante though, este programador esperou demasiado de suas audiências. Quis reduzir estas instruções a seus fundamentos desencapados, pensando que seriam adequados. Não considerou que mesmo um inteligente, se não o leitor cuidadoso pôde tempted saltar sobre instruções, ou anotou sobre algum detalhe crítico. Este é um pitfall comum quando o tempo é curto, e quando os usuários estão confrontados com as páginas e as páginas do texto bland.
Algumas imagens com cuidado escolhidas, com subtítulos apropriados, podem ir uma maneira longa para impedir isso. Quando eu vi que o programador júnior descascava afastado todas as imagens da captação de tela, eu adverti-o de encontro àquele. “Estas imagens não podem ser estritamente necessárias,” I dito, “mas elas ajudar esclarecer muitos dos detalhes. Para uma coisa, mostram ao usuário exatamente que tecla a empurrar, ou que janela a selecionar. Isto faz as instruções muito mais fáceis de compreender, e reduz a probabilidade de um erro humano.” A este dia, eu desejo que heeded meu aviso.
Os usuários inteligentes bastante para compreender o manual, como ele foram reivindicados? Certo-mas a inteligência não é nenhuma garantia de encontro ao erro humano. Poderiam as imagens ter sido interpretadas como falando para baixo ao usuário? Talvez-mas em minha experiência, os usuários sofisticados respondem raramente essa maneira. Rather, a maioria deles parecem compreender o valor que estas imagens trazem à tabela. Talvez é porque a maioria deles sabem que o que é como ser frazzled e pressionou por o tempo, e fàcilmente os detalhes importantes podem ser perdidos no texto.
Recordar-um assim pinturas do retrato mil palavras, e uma única captação de tela pode valer a pena mais do que as páginas uma dúzia do texto. É uma lição que valha a pena aprender.
Article Source: http://www.articleset.com

You are welcome to publish or reprint this article free of charge, provided:
- you include the entire article, unchanged, including the "About The Author" box
- all hyperlinks remain active, including the bottom ArticleSet.com link (does not apply to print publications)
- you agree not to hold the authors nor ArticleSet.com liable for any loss profits, expenses, or any other damages resulting from the use or misuse of articles published on this website