Praticar Treinar
Aprender a utilizar o produto nas operações quotidianas e habituais.
Os utilizadores têm de aprender a operar a maior parte das áreas de um produto que precisam de usar. Por exemplo, os administradores têm de aprender a criar e remover utilizadores. A ação Praticar descreve a necessidade de adquirir conhecimento processual, isto é, como utilizar o produto nas operações quotidianas e habituais.
Exemplos de documentação que permite praticar são Gerar uma nova chave SSH (GitHub), Importar contactos para o Mailchimp e Gestão de utilizadores (Dynatrace). Estes exemplos usam diferentes padrões de guias práticos ou tutoriais, podem ou não conter materiais audiovisuais, mas todos procuram atingir o mesmo objetivo: ajudar os utilizadores a dominar um procedimento.
Quando os utilizadores conseguem executar tarefas com confiança, é mais provável que explorem funcionalidades avançadas e se tornem defensores do produto. Este tipo de documentação serve frequentemente de espinha dorsal para programas de capacitação de utilizadores e percursos de certificação, transformando conhecimento teórico em competência prática.
O que o utilizador quer fazer
Os utilizadores têm de aprender a utilizar a maior parte das áreas de um produto. Praticar descreve a necessidade de adquirir conhecimento processual: como usar o produto nas operações quotidianas e habituais.
Sinais de que a documentação não responde a esta necessidade
- As mesmas perguntas sobre como fazer algo repetem-se nos canais de apoio e da comunidade.
- Os procedimentos existem apenas como conhecimento informal ou na cabeça de alguém.
- Não existe um guia passo a passo para tarefas administrativas comuns.
Dois exemplos reais
Tipos de conteúdo comuns
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <step>, <choicetable> | Guia prático | Guia prático |
Uma métrica
sucesso da tarefa · Percentagem de utilizadores que concluem um procedimento padrão sem apoio.