Escrevendo A Ajuda Útil? Uma Lista de verificação Do Minimalism
A documentação do usuário é toda escrita demasiado frequentemente por programadores para programadores. Tende a focalizar nas características de produto, melhor que nas tarefas do usuário. Geralmente, os programadores não estão na posição ideal a ser documentação do usuário da escrita. São demasiado perto dos bocados e dos bytes, e são demasiado longe do usuário. A, o que o produto pode fazer tende a ser-eles mais importante distante do que o que o usuário pode fazer com o produto.
É um subtle? mas vital? distinção. A pesquisa mostra que a chave à documentação do usuário eficaz é ajuda orientada tarefa da escrita. Mesmo melhore, escreva sua ajuda de acordo com a teoria do minimalist. No mundo da documentação, o "minimalism" é uma palavra extravagante para uma prática do commonsense. Em termos básicos, significa escreve a seu leitor e mantem-no simples.
A teoria própria tem muitos das torções e das voltas. Se você quiser ler um grande? mas ligeiramente wordy? registre no assunto, verificação para fora do livro "minimalism além do funil de Nurnberg", 1998, editado por John Carroll.
No ínterim, se você puder tiquetaquear cada artigo na seguinte lista de verificação, você estará bem em sua maneira à ajuda em linha usable que seus leitores e seus gerentes o agradecerão para.
Lista de verificação Útil Da Ajuda
1. Baseie a ajuda em tarefas reais (ou em exemplos realísticos)
2. Estruture a ajuda baseada na seqüência de tarefa? Os títulos do capítulo devem ser objetivos e os tópicos devem ser tarefas
3. Respeite a atividade do leitor? este é geralmente mais sobre o que você não faz do que o que você . Não desperdice o tempo do leitor mergulhando fora em tangents
4. Explore o conhecimento e a experiência prévios? Extraia a atenção do leitor às tarefas, às experiências, aos sucessos, e às falhas precedentes
5. Impeça erros - "assegure-o fazem x antes de fazer y"
6. Detecte e identifica erros - "se este falhar, você pode ter entrado no trajeto incorretamente"
7. Erros do reparo - "re-enter o trajeto"
8. Forneça o erro info no fim das tarefas onde necessário (a régua de polegar, uma nota do info do erro por três tarefas é uma média boa)
9. Não quebre acima instruções com notas, cuidados, avisos, e casos excepcionais - ponha estas coisas no fim da instrução, onde quer que possível
10. Seja sumário, não soletre tudo para fora, especial as coisas que podem ser feitas exame para concedido
11. Omita conceptual e anote a informação onde possível, ou a ligação a ela. Talvez forneça a informação da expansão no fim do tópico, mais talvez uma nota que há outras maneiras executar o task/goal, mas este é o mais fácil
12. As seções devem olhar o short e lê-lo brevemente
13. Forneça o fechamento para as seções (por exemplo, traseiro a screen/goal original)
14. Forneça uma oportunidade imediata de agir e incentivar a exploração e a inovação (os invitations ativos do uso agir, como, "vêem para yourself..." ou "tente isto..." melhor que os invitations passivos como, "você podem...")
15. Comece usuários começados rapidamente
16. Permita lendo em toda a ordem - faça cada seção modular, especial objetivos, mas talvez tarefas (definitivamente se puderem ser executados na ordem diferente)
17. Destaque as coisas que não são típicas
18. Use a voz ativa melhor que a voz passiva
19. Tente esclarecer o ambiente de usuário em sua escrita
20. Antes da escrita qualquer coisa, pergunte-se que " esta ajuda meu leitor?"
Construindo estas práticas em seu processo da documentação, você encontrará que sua ajuda em linha se torna mais fácil de escrever, mais curto, e distante mais usable para seu leitor. O que é mais, sua saliência amá-lo-á!
Sobre O Autor
* Glenn Murray é um specialist da submissão do copywriter e do artigo de SEO. É um diretor de PublishHub e também do estúdio copywriting divine escreva. Pode ser contatado em Sydney +612 4334 6222 ou em glenn@divinewrite.com. Visite http://www.divinewrite.com ou http://www.publishhub.com para uns detalhes mais adicionais, uns artigos MAIS LIVRES, ou para comprar seu e-livro, ' segredos de SEO.
Artigo Fonte: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster começa O Código do HTML
Adicionar este artigo para o seu site agora!
Webmaster enviar seus artigos
Nenhum registro necessário! Preencha o formulário e seu artigo está no Messaggiamo.Com Diretório!
