Escrita orientada a tarefa descreve-a como o usuário a executa.
Você raramente ajuda os usuários quando você apenas diz como um produto funciona internamente. Os seus usuários têm um trabalho a fazer, por isso eles precisam de informações práticas.
É necessário entender as tarefas que você está escrevendo pela perspectiva do usuário.
Tópicos de tarefas, seja de alto nível ou de baixo nível, são os mais importantes tipos de temas para os usuários, pois as tarefas ajudar os usuários a fazer o seu trabalho. Os usuários ficarão frustrados se não conseguirem completar uma tarefa.
Para tornar a informação orientada a tarefa, siga estas orientações:
1. Escreva para o público alvo.
Tenha certeza que você tem um claro entendimento do público alvo para o qual está escrevendo.
A definição do público alvo é importante para direcionar a linguagem e especificidade do material, por exemplo, se for um módulo destinado a usuários avançados, o texto não precisar ser muito detalhado, deve ser simples e objetivo, ao contrário de um texto para usuários com conhecimento básico que deve conter o passo a passo detalhado.
| Original | Revisado |
|---|---|
| Os passos abaixo descrevem de forma detalhada como alterar um arquivo, no entanto, a audiência consiste de usuários avançados que não precisam de auxílio para executar tarefas simples. | |
Para customizar as configurações:
| Para customizar as configurações, edite o arquivo INFODIR/SETTINGS.DEF. |
2. Apresente as informações do ponto de vista do usuário.
Escrever sob o ponto de vista do usuário traz o mesmo para a "estória", dessa forma, o usuário se imagina executando-a.
A escrita sob o ponto de vista do usuário tem as seguintes características, que serão melhor abordadas na área de Padrão de Escrita:
- Predomina a segunda pessoa.
- Usa voz ativa, com verbos que indicam ações que o usuário faz em oposição às ações que o produto faz.
Dar uma razão para as ações.
Quando estamos escrevendo a documentação de uma determinada tarefa, existe a vantagem de saber em que parte do produto os usuários estão, portanto, sabemos qual parte da tarefa o usuário precisa de ajuda.
O exemplo abaixo demostra um texto escrito de uma forma impessoal e sua revisão:
Original | Revisado |
|---|---|
O sistema poderá desligar durante o processo. Se isso acontecer, o sistema poderá ser reiniciado com o comando START RECOVER. | Se você desligar o sistema durante o processo, você poderá perder dados. Use o comando START RECOVER para reiniciar o sistema e recuperar qualquer dado do log. |
3. Indique uma razão prática para a informação
O usuário precisa compreender para que precisa da informação e como é relevante para sua tarefa. Uma tarefa não é apenas uma atividade, mas uma atividade que é direcionada para um fim específico.
Para garantir que as informações fornecidas são relevantes para a tarefa, siga as seguintes orientações:
Relacione a informação a uma tarefa quando necessário;
Original Revisado O primeiro texto indica o que é a opção mas não indica quando deverá utilizá-la ou para que. Se a opção NORES for usada, as rotinas serão link-editadas como parte do módulo. Utilize a opção NORES quando você não tiver espaço suficiente em disco para as rotinas serem link-editadas como parte do módulo.
Forneça apenas a quantidade necessária de informações conceitual, tópicos de tarefa devem conter apenas:
Justificação para a realização da tarefa.
Requisitos para fazer a tarefa (como tarefas ou software de pré-requisitos).
Passos da tarefa.
Dicas e exemplos para apoiar as etapas.
Informações sobre as tarefas subsequentes.
Não misture ações da tarefa com informações conceituais.Os usuários desejam aprender como fazer as coisas sem a necessidade de ler informações conceituais sobre o produto.
4. Se concentre em tarefas reais, e não funções do produto.
Uma tarefa real é uma tarefa que o usuário executa, independente do produto que está usando.
É comum, escritores técnicos escreverem com foco no produto e não tarefa real.
Exemplos de escritas real x produtos:
Produto | Real |
|---|---|
| Usando o editor de tabela | Editando uma tabela |
Para utilizar o Alterdata Manager:
| Para criar ou restaurar um backup:
|
5. Use títulos que revelam o que é a tarefa
O primeiro lugar para indicar ao usuário para que está sendo fornecida a informação é o título. Nele o usuário deverá ter uma ideia exata sobre o conteúdo do tópico, revelando o que o tópico contém informações sobre uma tarefa e qual é essa tarefa.
| Original | Revisado |
|---|---|
| Alguns dos títulos originais omitem o fato que o tópico está relacionado a uma tarefa. | |
Registro de uso Usando a Definição de Fonte Inicialização de uma sessão | Realizando o licenciamento do produto Definindo a fonte Inicializando uma sessão |
6. Divida as tarefas em sub-tarefas discretas.
Faça uma análise das tarefas para determinar quais tarefas são mais importantes para cada grupo de usuários, quais tarefas são mais frequentes, e quais as tarefas mais difíceis e faça uma lista das tarefas que os usuários vão fazer com o seu produto.
Em seguida, dividas em sub-tarefas discretas para que possa fornecer a informação a nível de passo a passo, que deve ter no máximo 9 ou menos passos. Se você tentar escrever a nível de passo a passo a tarefa principal de um processamento de folha, por exemplo, terá milhares de passos. Ao invés, você deverá dividir em sub-tarefas menores, como lançar hora-extra, registrar as faltas, cadastrar novos funcionários e etc.
Dessa forma, é importante antes de escrever as informações da tarefa levantar os itens abaixo e com base neles escrever, dividir e organizar as informações:
- Tarefas relacionadas a essa tarefa.
- Sequência de tarefas.
- Nível da tarefa.
- Interdependência da tarefa.
- É uma sub-tarefa de uma tarefa maior?
- É uma sub-tarefa ou são duas tarefas?
- É realmente uma sub-tarefa discreta?
- Tem sub-tarefas subordinadas?
7. Forneça instruções passo-a-passo, claras.
Tarefas são compostas de passos e, em geral, de vários passos ordenados. Qualquer passo que não seja claro ou não esteja na ordem correta compromete o resultado da execução da tarefa.
As seguintes diretrizes podem ser utilizar para criar instruções passo-a-passo claras?
- Deixe claro que cada passo é uma ação que o usuário deve executar.
- Agrupe os passos por usabilidade.
- Deixe claro os passos opcionais.
- Identifique os critérios no inicio dos passos condicionais