Deslizando entre as capas de um Documento Técnico

Quando você preparar um manual demorado, incluem todos os leitores de informação precisa e tornar as informações fáceis de encontrar. A seguir estão as diretrizes para o que incluir.

Índice

Sempre que o manual é mais do que 15 páginas, incluir uma tabela de conteúdo para ajudar os leitores facilmente encontrar o que precisam. Use líderes (.......) Para conectar os assuntos para os números de página para que os leitores podem executar seus olhos através da página.

Alguns autores utilizam números de capítulos internos. Por exemplo, Capítulo 1 é numerada 1-1, 1-2, 1-3, 1-4- Capítulo 2 é numerada 2-1, 2-2, 2-3, 2-4, e assim por diante. Isto é diferente de uma numeração consecutiva (1, 2, 3, 4). Use números de capítulos internos quando você antecipar atualizar um ou mais capítulos. Se o fizer, o impede de renumeração (e reimpressão) todo o manual.

Glossário

Se há uma dica de que seus leitores não podem compreender toda a terminologia no manual, incluir um glossário no final. Definir uma palavra a primeira vez que você usá-lo nem sempre é adequada, porque os leitores não vão ler o manual de capa a capa como se fosse o grande romance americano. Eles vão usá-lo para referência quando têm uma pergunta.

Se você escrever ajuda on-line, use janelas pop-up para termos. Se você escrever documentos da Web, crie um link para o glossário.

Índice

Nem todos os manuais precisa de um índice. O conteúdo do manual é o factor de propagação, e não o comprimento. Coloque-se no lugar do leitor e perguntar: Se eu estivesse lendo este documento, seria um índice ser útil? Se você acha que um índice iria ajudá-lo, incluir um. Ser muito sensível às palavras de pesquisa lógicas que o leitor pode procurar.

Aqui está uma história de uma mulher que comprou um carro novo. Ela dirigiu cerca de 25 milhas quando ela passou por cima de alguns vidro e tem um pneu furado. A mulher queria mudar o pneu-se e tirou o manual do proprietário. Ela verificou nas seguintes letras no índice:

• f para plana
• t para pneus
• j para jack
• c para mudar

A mulher não podia encontrar a informação e não podia acreditar que o manual negligenciado uma entrada tão importante. Ela finalmente desistiu e ligou para a American Automobile Association (AAA). Quando voltou para casa, ela começou a verificação de cada entrada de índice. Sim, havia uma entrada para mudar um pneu furado. Foi sob h para "Como mudar..."

Ao escrever para a Web, incluem um mapa do site ou algo equivalente.

Solução de problemas

Não importa quão bem você escreve um manual técnico, os leitores vão ter problemas. A maneira de abordar estas questões é a de incluir uma seção sobre solução de problemas. A Tabela 1 é uma grande seção de solução do Kodak DC215 Zoom Digital Guia do Utilizador da Câmara. Ele quebra o problema, causa e solução.

Tabela 1: Solução de problemas de uma câmera Kodak DC215 Zoom Digital

Problema	Causa	Solução
A imagem está muito clara.	Flash não é necessário.	Mude para Flash automático. Consulte a página 13.
O objeto estava muito próximo quando o flash foi usado.	Mantenha uma distância de pelo menos 1,6 pés (0,5 m) entre a câmera eo objeto.
O sensor de luz é coberto.	Segure a câmera para que suas mãos ou outros objetos não cubram o sensor de luz.
A compensação de exposição é definido incorretamente.	Diminua a compensação de exposição. Consulte a página 14.
As fotos armazenadas estão danificadas.	O cartão de memória da câmera foi removido quando a luz Pronta estava piscando.	Verifique se a luz Pronta não está piscando antes de remover o cartão.
O número de fotos restantes não diminui depois de tirar uma foto.	configurações de imagem resolução e qualidade não ocupa espaço suficiente para diminuir o número de fotografias restantes.	A câmera está funcionando normalmente. Continue a fotografar.
A imagem não é clara.	A lente está suja.	Limpar a lente. Consulte a página 65.
Objeto estava muito próximo quando a fotografia foi tirada.	Fique pelo menos 1,6 pés (0,5 m) em grande-angular, 3,3 pés (1m) em telefoto.
O objeto ou a câmera se moveu quando a foto foi tirada.	Segure a câmera firme até que a foto seja tirada.
O objeto está muito afastado para o flash para ser eficaz.	Mover assim que o assunto está a menos de 10 pés (.3m) de distância.

Quando você inclui uma seção sobre solução de problemas - ou perguntas mais frequentes (FAQs) em um documento eletrônico - você poupar o pessoal da orelha Help desk couve-flor. Veja como pensar com o que incluir na seção de solução de problemas:

• Se esta é a primeira edição do manual, pensar nas questões ou problemas que seus leitores possam ter. Certifique-se de incluir perguntas que os testadores tiveram durante testes alfa e beta.
• Se esta é uma segunda ou terceira edição, pedir às pessoas no balcão de ajuda para as perguntas mais freqüentes.

formulário de feedback

Para melhorar a qualidade do seu manual para a próxima impressão e para melhorar a qualidade de sua própria escrita, incluir um formulário de feedback. Esta forma dá aos leitores uma oportunidade para que você saiba o que eles gostaram e não gosto sobre o manual e para informá-lo de quaisquer erros que encontraram.

Não ser perturbado se você obter feedback principalmente negativo. Os leitores que estão satisfeitos com o manual geralmente não se preocupam em responder. Os leitores que não estão satisfeitos querem que você saiba. Tome este feedback construtivo e usá-lo como uma oportunidade para melhorar a sua técnica de escrita. Não tome isso pessoalmente.