Directrizes de criação de folhas de apontamentos
As folhas de apontamentos e as folhas de apontamentos compostas permitem que um
utilizador alcance um objectivo ao executar uma sequência de passos. Estas
directrizes indicam quando utilizar as folhas de apontamento e como gravar uma folha de apontamentos.
Quando criar folhas de apontamentos
As folhas de apontamentos adequam-se às tarefas que consistem de passos
que conduzem a um objectivo tangível, tal como a construção de uma aplicação simples.
O objectivo tem de estar bem definido, de modo a todos os passos da folha de
apontamentos sejam concluídos cm sucesso. Os guias de iniciação são óptimos
candidatos para as folhas de apontamentos. Num guia de iniciação, o objectivo é
aprender a executar uma tarefa específica. As folhas de apontamentos geralmente
contêm mais de 10 passos que podem ser concluídos em aproximadamente meia hora.
caso se trate de uma tarefa maior, considere a utilização de uma folha de apontamentos compósita.
Quando criar folhas de apontamentos compostas
As folhas de apontamentos compostas são utilizadas para facultar instruções ao
efectuar uma tarefa que seja demasiado grande para descrever numa única folha
de apontamentos ou que tenha vários objectivos. Uma folha de apontamentos compósita pode ser utilizada para descrever uma sequência de tarefas que
constroem no respectivo predecessor.
Quando não se deve utilizar folhas de apontamentos
As folhas de apontamentos têm um melhor funcionamento quando os problemas podem
ser resolvidos através de uma sequência de passos simples. Estas folhas não são um substituto do sistema de ajuda que permite a criação de
páginas HTML com gráficos complexos e acesso aleatório a informações através da
utilização de pesquisas e de hiperligações. As folhas de apontamentos não se
destinam a tarefas que requerem que o utilizador introduza uma grande quantidade de texto.
Directrizes para a criação de uma folha de apontamentos
- Escolha um título curto e significativo.
- Utilize ligações ao sistema de ajuda em tarefas da folha de apontamentos
sempre que possível, de modo a facultar o historial ou informações mais detalhadas
- Considere gravar novamente como folha de apontamentos compósita, caso existam mais do que 10 passos.
- Utilize comandos onde for possível para executar tarefas simples e
morosas, tais como abrir perspectivas, abrir recursos e executar assistentes.
Certifique-se também que faculta uma descrição do modo de obter o mesmo efeito
sem ter de utilizar o comando.
- Certifique-se que os comandos podem ser ignorados, caso o
utilizador decida executar os passos manualmente
- Especifique a caixa de diálogo ="true" para passos que abram caixas de diálogo.
Esta acção fará com que a folha de apontamentos abra num "tabuleiro"
do lado direito da maioria das caixas de diálogo.
- Organize os passos de forma a que o utilizador consiga ver frequentemente
sinais visíveis de sucesso. Uma folha de apontamentos que executa várias
alterações diferentes num destino Java e que lança uma aplicação, pode ser
gravada novamente para que a aplicação seja lançada após cada alteração de origem.
- Certifique-se que o utilizador compreende o motivo da execução de cada passo.
- Em vez de descrever várias formas de executar um passo , seleccione
a forma mais simples que necessite da mínima quantidade de descrição.
- Utilize identificadores (<br/>) de interrupção para melhorar a legibilidade.
- Os sub-artigos podem ser utilizados para dividir os passos em passos mais pequenos.
- Nem todas as folhas de apontamentos necessitam de sub-artigos.
- Inicie o texto da etiqueta do sub-artigo através da utilização de uma palavra
de acção, tal como "Entrada", "Expandir", "Seleccionar", etc
- No caso de etiquetas de sub-artigos, identifique claramente o texto de
interface através da utilização de plicas para permitir que os utilizadores
diferenciem o texto de instruções do texto da interface que necessitam de
localizar e com o qual necessitam de interagir.
- Cada sub-artigo deverá ser responsável por uma tarefa atómica, tal como a
introdução de um valor.
- Adicione sempre um elemento <onCompletion> ao último passo de uma
folha de apontamentos.
- Teste as folhas de apontamentos utilizando tamanhos diferentes para a vista de folhas de apontamentos.
- Teste as folhas de apontamentos com a vista de registo de erros
aberta para que possa ver se existe algum aviso gravado no registo.
Directrizes para a criação de uma folha de apontamentos compósita
- Uma folha de apontamentos compósita deverá conter tarefas relacionadas
através de um tema comum.
- Cada tarefa contida numa folha de apontamentos compósita deverá ter um objectivo bem definido.
- Utilize elementos <onCompletion> para reconhecer sucesso.
- Os nomes das tarefas devem ser curtos e concisos.
- Os problemas complexos podem ser solucionados através da utilização de
tarefas que constroem nos respectivos predecessores.
- Utilize skip="true", caso uma tarefa seja opcional.
- Por uma questão de consistência, certifique-se que a introdução e o nome da folha
de apontamentos simples correspondem ao nome especificado na folha de apontamentos compósita.
- No caso de descritores de tarefas, identifique claramente o texto da
interface através da utilização da formatação a negrito.
- As sequências deverão ser utilizadas apenas quando for importante fazer
cumprir a ordem na qual as tarefas podem ser iniciadas.
Ligações relacionadas
Trabalhar
com folhas de apontamentos
Trabalhar
com folhas de apontamentos compósitas
Folhas de apontamentos simples
Folhas de apontamentos compósitas