A interface do Izly e as vozes dos vídeos estão em inglês e turco. Os guias e as automações funcionam com sites em qualquer idioma.
Como criar documentação de treinamento de um sistema?
Uma boa documentação de treinamento é um conjunto de guias curtos, um para cada tarefa que uma pessoa nova precisa aprender. O método abaixo serve para qualquer sistema que roda no navegador.
- Escolha a tarefa. Uma tarefa, um resultado, por exemplo “Enviar um pedido de reembolso”.
- Grave uma vez. Faça a tarefa em uma conta de teste enquanto o gravador captura cada clique.
- Limpe os passos. Reescreva os passos vagos, exclua cliques acidentais e junte os minúsculos.
- Acrescente dicas e avisos. Marque o que não pode ser desfeito e o que as pessoas costumam errar.
- Cubra os dados privados. Tire das imagens nomes, e-mails, valores e números de documentos.
- Publique. Envie um link, um PDF ou um arquivo Word.
- Mantenha atual. Dê ao guia um responsável e uma data de revisão.
Quais tarefas devo documentar primeiro?
Comece pelas tarefas que geram mais perguntas. Pergunte às últimas três pessoas que entraram na equipe o que elas precisaram perguntar no primeiro mês. A configuração de acessos, o primeiro relatório mensal e o formulário que todo mundo preenche no segundo dia costumam estar na lista.
Deixe de fora as tarefas que acontecem uma vez por ano e as que mudam toda semana. Uma lista curta de dez guias que as pessoas usam vale mais do que cem que ninguém abre.
Como é um guia pronto?
Exemplo: “Enviar um pedido de reembolso” em um sistema financeiro web, gravado em uma conta de teste com um comprovante inventado.
| Como foi gravado | Depois da limpeza |
|---|---|
| Clique em Novo | Clique em Novo pedido no canto superior direito |
| Clique em Valor, digite 48,50 | Digite em Valor a quantia do comprovante |
| Clique em Anexar | Clique em Anexar e escolha a foto do comprovante |
| Clique em Enviar | Clique em Enviar. Aviso: um pedido enviado não pode ser editado |
O último passo mostra por que os avisos importam. O bloco de aviso fica junto do passo a que pertence, então ninguém precisa rolar até o fim da página para achá-lo.
Como manter dados privados fora das capturas de tela?
Primeiro, use uma conta de teste e registros inventados. Segundo, cubra o que sobrar. Uma forma desenhada sobre um nome não o remove do arquivo da imagem, então use um método que mude os pixels. No Izly, os pixels cobertos são removidos no servidor. As senhas nunca são gravadas.
Confira o guia inteiro você mesmo antes de compartilhar: a cobertura é manual, e só o que você cobrir fica coberto.
Em qual formato devo publicar?
| Formato | Use quando | Plano |
|---|---|---|
| Link de compartilhamento | As pessoas devem sempre ver a versão atual. Você pode desativar o link a qualquer momento | Todos os planos |
| Incorporação | O guia deve ficar dentro de uma página de ajuda ou da intranet | Todos os planos |
| Você precisa de um material de apoio, de uma pasta de auditoria ou de leitura sem internet | Todos os planos, com rodapé pequeno no Free | |
| Word | Alguém vai editar o guia ou colocá-lo dentro de um documento maior | Pro e Studio |
| HTML | Você quer publicar o guia no seu próprio site | Pro e Studio |
| Markdown | O guia vai para uma wiki ou para uma pasta de documentação | Pro e Studio |
| Vídeo narrado | Quem prefere ouvir, ou uma apresentação do primeiro dia. As vozes são em inglês e turco | Teste gratuito de 3 guias, 15 por mês no Pro, ilimitado no Studio |
Um link é o melhor padrão, porque uma atualização chega a todo mundo de uma vez. Um PDF ou um arquivo Word é uma cópia do momento em que foi exportado. O vídeo narrado só tem voz em inglês ou turco; se a sua equipe não fala nenhum dos dois, o guia escrito e o PDF servem melhor.
Como manter a documentação de treinamento atual?
- Dê um responsável a cada guia. Um guia sem responsável é o primeiro a ficar velho.
- Escreva uma data de revisão nele e olhe-o quando o sistema lançar uma mudança.
- Edite só o passo que mudou. Não é preciso regravar o guia inteiro por causa de um botão que mudou de lugar.
- Pergunte aos leitores. Uma linha, “Este guia estava correto?”, acha erros mais rápido do que uma revisão anual.
Como cada passo é separado, atualizar custa pouco. Esse é o motivo de gravar um guia em vez de colar capturas de tela em um documento à mão.
O que este método não cobre?
O Izly grava tarefas no Chrome de computador. Um programa instalado no computador, ou uma tarefa no celular, não pode ser gravado. Um guia mostra como fazer uma tarefa; ele não ensina por que um processo existe, então combine-o com um procedimento escrito (um POP) quando o motivo importar. A interface do Izly e as vozes do vídeo estão em inglês e turco, mas o guia que você grava pode ser de um sistema em português.
Como gravo documentação de treinamento com o Izly?
Izly (izly.io) é uma extensão do Chrome que transforma uma tarefa que você faz uma vez no navegador em um passo a passo, um vídeo narrado e uma automação sem código que repete a tarefa. Para documentação de treinamento, importam os dois primeiros: o guia e o vídeo saem da mesma gravação.
Cada clique e cada texto digitado vira um passo com captura de tela, e você arruma tudo no editor: edita textos, reordena, junta, acrescenta um bloco de dica, aviso ou título, recorta, põe setas e cobre áreas sensíveis. O plano Free tem 10 guias e PDF. Veja os preços ou comece grátis. Para um passo a passo com capturas de tela, veja também criar passo a passo com prints automáticos.
Perguntas frequentes
Quantos guias um treinamento precisa ter?
Comece pelas dez tarefas que mais geraram perguntas nos últimos meses. Acrescente um guia quando alguém perguntar a mesma coisa duas vezes. O número importa menos do que saber se as pessoas abrem os guias.
Devo usar vídeo ou guias escritos?
Use passos escritos para tarefas que as pessoas repetem e consultam, e um vídeo narrado como apresentação. Os dois podem sair da mesma gravação, então você não precisa escolher de antemão. As vozes do vídeo são em inglês e turco.
Quem lê precisa de uma conta?
Quem só assiste não paga nunca. Os planos são cobrados por criador, então só paga quem grava e edita guias, e o plano Free cobre 10 guias.
Posso transformar o mesmo guia em um material de apoio?
Pode. A exportação em PDF está em todos os planos, com um rodapé pequeno no Free. Word, HTML e Markdown estão no Pro e no Studio.
Vale documentar um sistema que muda com frequência?
Vale, se atualizar for barato. Como cada passo é separado, você edita só o passo que mudou. Esse é o motivo de gravar um guia em vez de colar capturas de tela em um documento à mão.
Páginas relacionadas
Grave uma vez e deixe o guia se escrever sozinho
Com o Izly você faz a tarefa uma vez no navegador. Os cliques e as capturas de tela viram um passo a passo que você edita, compartilha, transforma em vídeo narrado ou executa de novo para cada linha de uma tabela. A interface do Izly e as vozes dos vídeos estão em inglês e turco.