Diretrizes de Autoria de Folha de Dicas
Folhas de dicas e folhas de dicas compostas permitem que o usuário atinja um objetivo executando uma seqüência de etapas. Essas orientações discutem quando utilizar a folha de dicas e a melhor forma de gravar uma.
Quando Criar Folhas de Dicas
Folhas de dicas são bem adequadas às tarefas que consistem em etapas que levam a
um objetivo tangível, como a criação de um aplicativo simples. O objetivo deve ser bem definido para que o usuário possa obter êxito quando todas as etapas da folha de dicas forem concluídas. Os tutoriais geralmente são bons candidatos para folhas de dicas; em um
tutorial, o objetivo é aprender como executar uma tarefa específica. Geralmente, as folhas de dicas contêm até 10 etapas e podem ser concluídas em meia hora ou menos.
Para tarefas maiores, considere utilizar uma folha de dicas composta.
Quando Criar Folhas de Dicas Compostas
As folhas de dicas compostas são utilizadas para fornecer orientação
por meio de uma tarefa que seja muito grande para ser descrita em uma única folha de
dicas ou que tenha muitos objetivos. Uma folha de dicas composta pode ser
utilizada para descrever uma seqüência de tarefas, cada uma construída no seu predecessor.
Quando Não Utilizar Folhas de Dicas
As folhas de dicas funcionam melhor quando o problema pode ser resolvido com uma seqüência de etapas simples. As folhas de dicas não são um substituto do sistema de ajuda, que permite a criação de páginas HTML com gráficos ricos e acesso aleatório de informações utilizando pesquisa e hyperlinks. Folhas de dicas não são designadas para tarefas que requerem que o usuário insira muito texto.
Orientações para Criação de uma Folha de Dicas
- Escolha um título curto e significativo.
- Utilize links para o sistema de ajuda nas tarefas da folha de dicas quando possível para fornecer informações de experiência ou informações mais detalhadas
- Considere regravar como uma folha de dicas composta, se houver mais de 10
etapas.
- Utilize comandos, quando possível, para executar tarefas tediosas, como abrir perspectiva, abrir recursos, executar assistentes. Lembre-se também de
fornecer uma descrição de como obter o mesmo efeito sem utilizar o
comando.
- Certifique-se de que os comandos possam ser ignorados se o usuário decidir executar as etapas manualmente
- Especifique o diálogo="true" para etapas que abram diálogos. Isso fará com que a folha de dicas seja aberta em uma "bandeja" à direita da maioria dos diálogos.
- Organize as etapas de forma que o usuário veja sinais visíveis de êxito com freqüência. Uma folha de dicas que faça diversas alterações diferentes na origem Java e, em seguida, ative um aplicativo pode ser regravada para que o aplicativo seja ativado após cada alteração de origem.
- Certifique-se de que o usuário compreenda porque está executando cada etapa.
- Em vez de descrever várias formas de executar uma etapa, opte pela
forma mais simples, que requer menos descrição.
- Utilize tags de quebra (<br/>) para melhorar a capacidade de leitura.
- Os subitens podem ser utilizados para decompor etapas em etapas menores.
- Nem todas as folhas de dicas precisarão de subitens.
- Inicie o texto da etiqueta do subitem utilizando uma palavra de ação, como "Entrada", "Expandir",
"Selecionar", etc.
- Para etiquetas de subitem, identifique claramente o texto da interface utilizando aspas para permitir que os usuários diferenciem o texto da instrução do texto da interface que eles precisam localizar e com a qual interagir.
- Cada subitem deve ser responsável por uma tarefa atômica, como a entrada de um valor.
- Sempre inclua um elemento <onCompletion> na última etapa de uma folha de dicas.
- Teste folhas de dicas com diferentes tamanhos para a visualização de folha de dicas.
- Teste folhas de dicas com a visualização de registro de erros aberta para poder ver se algum aviso foi gravado no registro.
Orientações para Criação de uma Folha de Dicas Composta
- Uma folha de dicas composta deve conter tarefas que estejam relacionadas por um tema comum.
- Cada tarefa de uma folha de dicas composta deve ter um objetivo bem definido.
- Utilize elementos <onCompletion> para reconhecer o êxito.
- Os nomes de tarefa devem ser curtos e concisos.
- Problemas complexos podem ser resolvidos utilizando tarefas construídas em seus
predecessores.
- Utilize skip="true" se uma tarefa for opcional.
- Por questão de consistência, verifique se a introdução e o nome da folha de dicas simples correspondem à introdução e ao nome especificados na folha de dicas composta.
- Para descrições da tarefa, identifique claramente o texto da interface utilizando negrito.
- As seqüências devem ser utilizadas apenas quando for importante impor a ordem em que as tarefas podem ser iniciadas.
Links Relacionados
Trabalhando
com Folhas de Dicas
Trabalhando
com Folhas de Dicas Compostas
Folhas de Dicas Simples
Folhas de Dicas Compostas