A documentação é a outra metade de um tutorial
Algumas pessoas assistem, outras passam os olhos, e os mecanismos de busca indexam as palavras. Produzir um vídeo e um guia escrito separadamente significa escrever o mesmo passo a passo duas vezes. O Capture já entende o seu tutorial bem o suficiente para limpar a narração, então a versão escrita sai do mesmo trabalho.
Como o Generate guide funciona
- Edite o tutorial normalmente. Cortes e ajustes são levados para o guia.
- Clique em Generate guide no editor. Se o projeto ainda não tem transcrição, o Capture transcreve primeiro.
- O Capture escreve o guia a partir da transcrição, de preferência a sua narração otimizada, e dos seus cliques: um título, uma introdução e etapas numeradas.
- Cada etapa recebe uma captura de tela da gravação no momento em que você clicou, além de um link para ir até aquele momento no vídeo.
Mude a edição depois e o guia é marcado como desatualizado. Gere novamente para alinhá-lo outra vez.
Como escrever documentação de software quando você prefere demonstrar
Pergunte a qualquer pessoa que mantém uma central de ajuda o que torna a documentação lenta, e a resposta nunca é a digitação. É decidir a ordem das etapas, lembrar do pré-requisito que você pula automaticamente e descrever uma tela de memória com precisão suficiente para que um desconhecido consiga seguir.
Demonstrar a tarefa resolve os três. Você executa as etapas na ordem certa porque o produto obriga, o pré-requisito aparece porque você realmente o cumpre, e a tela é descrita com precisão porque a gravação é a tela. Depois, você edita um rascunho em vez de encarar uma página em branco.
Uma boa documentação ainda precisa de uma pessoa decidindo o que importa. Ela só não precisa de alguém transcrevendo os próprios cliques.
Onde isso se encaixa no Braiv Capture
Os guias são um recurso de cauda longa do Braiv Capture, construído sobre a otimização da narração. Os guias são escritos no idioma original do tutorial. Para guias escritos a partir de vídeos que já estão no YouTube, veja vídeo do YouTube para artigo de suporte.
