Criador de estrutura de tutorial

Receba uma estrutura de tutorial em Markdown, do objetivo à tarefa prática.

Roda no seu navegador
Sem uploads
Sem conta

Carregando a ferramenta no navegador…

O que faz: Criador de estrutura de tutorial

Tutoriais que ficam na memória seguem uma estrutura de ensino: dizer o que o aluno vai conseguir fazer, listar o que ele precisa antes, percorrer os passos, recapitular e dar algo para praticar. Informe a tarefa, cole os seus passos em rascunho, um por linha, e o criador escreve essa estrutura em Markdown.

A numeração e os marcadores dos seus passos são removidos e refeitos, um “How to” no início da tarefa (em inglês) é removido para o título não repeti-lo, e passos sugeridos, marcados como sugestões, aparecem se você ainda não escreveu nenhum. Títulos e linhas que terminam com dois-pontos não são tratados como passos. Os pré-requisitos ficam em Mais opções.

Exemplo

Entrada

O que os alunos vão conseguir fazer?: Conectar sua agenda
Passos:
1. Abra Configurações e escolha Integrações
2. Clique em Conectar ao lado de Google Agenda
3. Aprove o acesso na janela pop-up

Resultado

# Tutorial: conectar sua agenda

## Objetivo de aprendizagem
Depois deste tutorial, o público (novos usuários) consegue fazer sem ajuda: conectar sua agenda.

## Recapitulação
- Você concluiu 3 passos. Tarefa: conectar sua agenda
- Confira se o resultado corresponde ao que o último passo mostrou

Sem público informado, o objetivo usa “novos usuários”. As seções Pré-requisitos, Passos e Tarefa prática ficam entre essas seções e depois delas.

Como usar: Criador de estrutura de tutorial

Informe o que os alunos vão conseguir fazer, como “Conectar sua agenda”.
Cole os Passos, um por linha, adicione um Público e liste os Pré-requisitos em Mais opções.
Copie a estrutura ou use Baixar .md e grave a partir dela.

Bom saber

Os passos são usados como foram escritos, exceto pela primeira letra em maiúscula. Divida antes as linhas que têm duas ações; o Verificador de complexidade de instruções aponta essas linhas.
A estrutura não tem tempos. Para a duração, coloque os mesmos passos na Calculadora de duração de vídeo de treinamento.
Sem pré-requisitos, duas sugestões são adicionadas abaixo de uma nota dizendo que nenhum foi informado. Substitua-as ou apague a seção se a tarefa não precisar de nada.

Perguntas sobre Criador de estrutura de tutorial

Como estruturo um tutorial?

Escreva primeiro o objetivo de aprendizagem, depois liste os pré-requisitos e em seguida os passos em ordem, com uma ação cada. Termine com uma recapitulação curta e uma tarefa prática para que os alunos repitam a habilidade sem o vídeo.

Por que incluir uma tarefa prática no fim de um tutorial?

Assistir não é o mesmo que fazer. Uma tarefa prática, como repetir os passos com outros valores, faz o aluno lembrar o processo e mostra se ele consegue se virar sem o vídeo.

Quais pré-requisitos um tutorial deve listar?

Tudo o que impede o aluno de começar: a função ou a permissão necessária, o plano ou o recurso que precisa estar ativado e os arquivos ou dados que devem estar à mão. Listar isso evita que as pessoas travem no passo dois.

Posso transformar a estrutura em um guia escrito?

Sim. O Markdown serve de esqueleto para um artigo de ajuda: cole na sua ferramenta de documentação e adicione uma captura de tela abaixo de cada passo. A Polysh também pode criar um guia passo a passo direto de uma gravação de tela.