Ir para o conteúdo
Bookeen

Guias práticos em ebook

Saber como escrever um guia prático serve para ajudar o leitor a concluir uma tarefa específica. Comece pelo resultado, mostre os passos em uma ordem viável e explique como saber se cada passo deu certo.

Comece seu livro, grátis

O que é um guia prático em ebook?

Um guia prático é um livro instrucional organizado em torno de fazer algo: montar um processo, aprender uma habilidade prática ou concluir um projeto. Cada capítulo deve aproximar o leitor do resultado prometido. O contexto entra onde ajuda a decidir, e a solução de problemas fica perto do passo em que o leitor pode travar.

Como um guia prático deve organizar os seus passos?

Um guia prático deve colocar as ações na ordem em que o leitor precisa executá-las. Informe as condições de partida, descreva a ação e mostre como verificar o resultado. Numere uma sequência de várias etapas para que o leitor não perca o lugar.

A procedure is a sequence of numbered steps for accomplishing a task.

Tradução: Um procedimento é uma sequência de passos numerados para realizar uma tarefa.

Guia de estilo da documentação para desenvolvedores do Google, Procedures
  • O guia de procedimentos do Google usa uma frase e um marcador para um procedimento de uma única etapa, em vez de uma lista numerada que contenha apenas 1.
  • Em um procedimento com duas ou mais ações, diferencie a sequência de uma lista sem ordem de materiais ou opções.
  • Neste exemplo de oficina do Bookeen, use três pontos de verificação: confirmar o público, aprovar o plano da sessão e conferir os materiais. O número pertence a este exemplo, não a todos os guias práticos.

Use o Bookeen para desenvolver a sequência de capítulos a partir das suas notas de processo. Em seguida, execute você mesmo as instruções ou peça a um leitor adequado que as teste; passos numerados que parecem claros não provam que o procedimento funciona.

Fonte verificada .

Quando escolher este tipo de livro

  • Escolha um guia prático quando o leitor precisar de uma sequência repetível.
  • Defina o que o leitor já sabe e o que ele precisa antes de começar.
  • Use um caderno de exercícios quando as atividades e as respostas escritas carregarem a maior parte do valor.

Um esboço prático

  1. Descreva o resultado e as condições de partida.
  2. Reúna materiais, informações ou pré-requisitos.
  3. Percorra os passos com um exemplo contínuo.
  4. Confira o resultado, resolva problemas e planeje a próxima ação.
Exemplo ilustrativo

Um guia para planejar a primeira oficina comunitária

Acompanhe uma organizadora de um tema aproximado até um plano de sessão viável. O capítulo sobre o público identifica quem deve participar. O seguinte transforma esse público em um objetivo de aprendizagem e, depois, em uma agenda e uma lista de materiais. Os leitores podem comparar as próprias decisões com o exemplo contínuo em vez de começar do zero em cada capítulo.

A quem um guia prático deve se dirigir?

Um guia prático deve se dirigir a um leitor definido, em um ponto de partida claro. Defina o leitor antes de escrever. Explique os termos especializados onde eles são usados e evite acrescentar capítulos só porque você conhece bem o assunto.

  • Informe os pré-requisitos desde o início.
  • Separe os passos obrigatórios das melhorias opcionais.
  • Faça com que o resultado seja observável.

Teste as instruções

Um guia pode parecer claro e ainda assim omitir uma ação essencial. Percorra a sequência como o leitor faria. Confira as dependências, os exemplos e qualquer referência a ferramentas ou telas conforme o comportamento atual.

  • Use nomes consistentes para a mesma ação.
  • Adicione pontos de verificação após os passos importantes.
  • Explique os erros comuns e as opções de recuperação.

Monte um rascunho no Bookeen

Dê ao Bookeen o seu público, o resultado e as suas notas de processo. Use essas entradas para desenvolver um esboço e revise cada capítulo em busca de passos que faltam. A sua experiência e a sua verificação tornam as instruções úteis.

  • Mantenha um exemplo ao longo de todo o guia.
  • Substitua conselhos genéricos por decisões e ações.
  • Revise a sequência completa antes de preparar os arquivos para o leitor.

Comparar tipos de livro

Leitores, arquivos e próximos passos

Explore uma situação de escrita relacionada e escolha uma edição que combine com os seus leitores.

Explore o criador de livros do Bookeen

Guias práticos em ebook: perguntas respondidas

Qual é a diferença entre um guia prático e um caderno de exercícios?

Um guia prático explica um processo. Um caderno de exercícios dá ao leitor espaço e propostas para aplicá-lo. Os dois podem ser combinados, mas um deles deve conduzir a estrutura para que o leitor saiba se deve seguir instruções ou completar exercícios.

Todos os capítulos precisam ter o mesmo tamanho?

Não. Dê a cada passo a explicação suficiente para que ele seja utilizável. Uma decisão complexa pode precisar de alternativas e um exemplo; uma ação simples pode precisar apenas de uma instrução curta e uma verificação.

Um guia prático deve incluir solução de problemas?

Sim, onde você conseguir identificar pontos de falha reais. Explique o sintoma, a causa provável e a próxima ação perto do passo correspondente. Evite inventar problemas só para deixar um capítulo mais longo.

Posso transformar artigos existentes em um guia?

Sim, mas reescreva-os como uma única sequência. Remova introduções repetidas, preencha lacunas entre os passos e mantenha a terminologia consistente. Um guia útil precisa de uma jornada contínua para o leitor, não apenas de uma coleção de artigos.

Qual formato de arquivo devo escolher?

O EPUB funciona bem para textos que o leitor redimensiona em telas diferentes. O PDF preserva um layout específico. Mantenha um manuscrito editável durante a revisão e inspecione a edição exportada antes de compartilhá-la.

Transforme o seu conhecimento em passos claros.

Monte um guia prático no Bookeen em torno de um resultado útil, uma sequência prática e exemplos que os seus leitores possam seguir.

Comece seu livro, grátis

Planos mensais simplesCancele quando quiserTudo é seu