Escrevendo um manual

Escrever um manual pode parecer uma tarefa assustadora, mas é mais fácil do que você pensa! As etapas deste artigo podem ser usadas para qualquer tutorial escrito, seja uma instrução bastante simples (como bater palmas) ou muito complicada (como construir um semicondutor).

Degraus

Método 1 de 4: Conhecendo o assunto

Imagem intitulada Encontre um emprego se você tiver uma deficiência Passo 3
1. Esta é a coisa mais importante a fazer. Pode parecer óbvio, mas o conhecimento é a chave para escrever um manual de sucesso. Por exemplo, se você está escrevendo um manual para uma câmera fixa, ajuda saber que o número de abertura e a velocidade do obturador não são apenas duas funções separadas - elas são - mas saber como as duas interagem ajudará muito. mais fácil para você descrever cada função em relação ao todo.
Imagem intitulada Sucesso no Marketing de Rede Passo 16
2. Fale com especialistas. Se o seu papel é simplesmente um redator e não um especialista no assunto, envolva pessoas com conhecimento em todo o processo e certifique-se de que elas revisem e revisem seu trabalho. Seu conhecimento e conselhos são inestimáveis.
Imagem intitulada Torne-se uma modelo baixinha Passo 7
3. Experimente uma abordagem prática. Ter a capacidade de realmente fazer as coisas sobre as quais você escreve pelo menos lhe dará uma ideia do que exatamente o usuário vai querer saber.
Imagem intitulada Pense como um designer gráfico Passo 12
4. Leia sobre o tema. Aprenda o jargão e conheça bem o produto sobre o qual está escrevendo.
  • Confira guias de produtos semelhantes para ver como outros escritores abordaram o tópico.
  • Procure semelhanças entre os escritores. Isso lhe dirá mais sobre as funcionalidades comuns e as formas usuais em que a descrição do produto é abordada.
  • Procure diferenças perceptíveis. Essas são provavelmente as funcionalidades exclusivas de um determinado produto. Seu produto pode ou não ter essas funcionalidades, ou ter outras formas de resolver o problema. Você pode descrever essas formas e assim aumentar o valor do produto. Embora seu trabalho possa ser escrever uma instrução, mostrar aos clientes o valor de sua compra é uma ótima maneira de incentivá-los a continuar lendo.
  • Devorar revistas comerciais. Descubra como as pessoas que usam os produtos trabalham com eles no dia a dia. Eles podem desejar que houvesse uma funcionalidade que resolvesse seu problema específico. Se o seu produto é a solução, você tem que mostrar claramente.
  • Método 2 de 4: Crie um layout para o seu manual

    Imagem intitulada Do Research Step 19
    1. Quebre-o em pedaços. Seja um guia simples e rápido que explica tudo passo a passo ou um guia abrangente para uma câmera digital de 35 mm, dividir as informações em pedaços pequenos tem vários benefícios:
    • Você pode se concentrar nas partes individuais do todo. Seu objetivo é familiarizar o usuário com como aprender o processo. Você pode dizer como a função deve ser executada em um tutorial no final, se quiser. Você também pode deixar para o usuário descobrir por si mesmo.
    Imagem intitulada Barter Step 19
    2. Use uma ordem lógica. Por exemplo, não é uma boa ideia descrever como o flash de uma câmera funciona até que você tenha mostrado como colocar a lente, inserir o rolo de filme, ligar a câmera e focar. Isso é especialmente útil se você não conhece muito bem o assunto.
    Imagem intitulada Escreva um esboço biográfico Passo 2
    3. Use isso como seu modelo de índice.
    Imagem intitulada Defenda-se contra a apropriação de reivindicações de nome ou semelhança Etapa 15
    4. Verifique seus passos novamente. Depois de definir um layout com seções lógicas, revise-as para garantir que cobriu todos os tópicos.
    Imagem intitulada Consiga um emprego em outro estado Passo 11
    5. Reúna seus suprimentos. Certifique-se de ter as coisas que você descreve disponíveis e que elas estão prontas para serem usadas conforme você descreve no manual. Se você estiver fazendo uma caixa de papel, tenha papel, tesoura, fita adesiva, cola e uma régua prontas. Se você estiver escrevendo sobre uma câmera, certifique-se de desmontá-la. O produto sobre o qual você está escrevendo deve estar de volta na caixa agora, se possível.

    Método 3 de 4: Comece a escrever

    Imagem intitulada Candidate-se a um subsídio empresarial Passo 8
    1. Escreva a introdução. A introdução dá o tom de todo o manual e dá ao usuário uma ideia de que tipo de manual ele está prestes a ler. Sua introdução é divertida e fácil de ler ou clara, simples e profissional? Depende do seu leitor. Você tem muito mais espaço para brincar com a linguagem quando ensina as crianças a fazer uma caixa de papel do que quando ensina um médico a realizar uma cirurgia cardíaca aberta. Portanto, defina o tom com antecedência e cumpra-o enquanto escreve todo o manual.
    Imagem intitulada Conecte os fones de ouvido ao PS3 Passo 19
    2. Execute cada etapa enquanto escreve. Isso não apenas dá ao seu texto uma aparência honesta e real, mas também garante que você não esqueça nada.
  • Se por algum motivo não for viável realizar as etapas, pense bem e procure aconselhamento de um especialista.
  • Imagem intitulada Faça um sistema operacional de computador Passo 1
    3. Numere os passos. Isso torna mais fácil para seus leitores seguirem o texto e recuperarem informações caso se percam.
  • Se você estiver escrevendo em papel, certifique-se de deixar espaço entre cada etapa para que você possa adicionar mais informações. Lembre-se de renumerar suas etapas ao adicionar novas etapas.
  • Imagem intitulada Spot Fake News Sites Etapa 8
    4. Adicione dicas e avisos. Ao escrever, você pode perceber que quando um usuário executa uma etapa casualmente, isso pode causar um problema.
  • Se, por outro lado, você acha que determinado conhecimento tornará a tarefa do usuário mais fácil ou mais interessante, adicione-o.
  • Imagem intitulada Conecte os fones de ouvido ao PS3 Passo 17
    5. Teste seu manual. Execute as coisas sobre as quais você escreveu usando apenas suas instruções escritas. Se você achar que suas instruções não contêm as informações necessárias em determinados lugares, adicione-as. Repita esta etapa até que você tenha passado por todas as etapas e possa fazer o que está tentando ensinar aos leitores sem precisar adicionar mais informações.
  • Considere deixar um ou dois amigos usarem seu manual. Observe-os cuidadosamente enquanto aprendem a usar o produto. Veja por quais etapas eles passam rapidamente. Descubra onde eles se perdem, se confundem ou fazem o trabalho errado. Ouça o que eles têm a dizer e ajuste seu guia de acordo.
  • Imagem intitulada Consiga um Emprego Rápido Passo 1
    6. Corrija seu manual. Você não quer enviar ao revisor final (seja um editor ou seu parceiro) um manual cheio de erros irritantes.

    Método 4 de 4: Formatando o texto

    Imagem intitulada Escreva uma proposta de doação Etapa 16
    1. Comece no nível superior. Depois de descrever claramente todas as etapas necessárias, consulte seu manual para encontrar os títulos claramente reconhecíveis das diferentes categorias.
    • Dê-lhes um título e anote onde eles estão em seu manual.
    Imagem intitulada Escreva uma proposta de doação Etapa 18
    2. Escreva um índice, se aplicável. Como exemplo, veja como o wikiHow está organizado. A página inicial tem uma lista das diferentes categorias. Ao escolher uma determinada categoria, você verá as várias subcategorias e lá encontrará os artigos. Quanto mais detalhado for o seu guia, mais categorias e subcategorias você precisará. Um artigo sobre como assobiar não precisa de um. Um texto sobre como esculpir uma flauta em madeira, por outro lado, precisa de alguns. Finalmente, um artigo sobre como tocar flauta precisa de muitos!
    Imagem intitulada Escreva uma proposta de doação Etapa 7
    3. Corrija seu manual novamente. Sim, você já fez isso completamente. Se você fizer isso uma segunda vez, sem dúvida encontrará alguns outros pequenos erros ou lugares onde seu manual simplesmente não está claro.
  • Para um guia mais abrangente, você também pode usar esta opção para anotar todos os tópicos menores e usar essas informações para criar um índice.
  • Imagem intitulada Defenda-se contra a apropriação de reivindicações de nome ou semelhança Etapa 2
    4. Pense em um título.

    Pontas

    • Mesmo que algo pareça completamente claro para você, você ainda precisa escrever as etapas! Isso ajudará você a evitar pular algo que o usuário não sabe. É melhor adicionar informações adicionais do que omitir etapas importantes.
    • Se você está escrevendo um manual muito detalhado que exige que você divida o texto em capítulos, como instruções sobre como tocar flauta, seu primeiro passo pode ser listar todos os capítulos, como Escolhendo uma flauta, Montando e mantendo a flauta, Produzindo notas musicais, Dedilhados, Sua primeira peça musical, e assim por diante. Então você aplica as regras básicas para escrever um manual para cada capítulo, porque cada capítulo é, por assim dizer, um manual separado!
    • Forneça ilustrações com suas instruções sempre que possível! Se você não puder adicionar imagens, consulte algo familiar como exemplo. Abelha Etapa 2 de "Formate o texto" por exemplo, este artigo faz referência ao layout para ilustrar como você pode criar um sumário.
    • Se possível, peça a um iniciante que teste seu manual e anote todas as perguntas que a outra pessoa fizer. Isso irá ajudá-lo a preencher as peças que faltam e tornar seu manual muito mais útil.
    • Escrever cada seção em uma página separada (ou em um computador) tornará a edição muito mais fácil. Você pode reorganizar seu manual com mais facilidade se tiver espaço para trabalhar e encontrar suas anotações para personalização. Deixe 3 ou 4 linhas em branco no computador (pressionando várias vezes) tecla Enter pressionando) entre todas as etapas para que você possa encontrar facilmente as divisões entre as diferentes partes.

    Оцените, пожалуйста статью