Como escrever um ótimo guia
Use essas orientações para redigir manuais bons de verdade e, assim, ajudar pessoas a consertar seus próprios aparelhos!
O que deve ser feito
Contribua!
Antes um guia na mão do que dois voando. O que vem a seguir não são regras, e sim orientações. Até nós mesmos nos esquecemos às vezes de seguir todas essas orientações à risca, e voltamos para reeditar algo, quando preciso. Sabemos que somos todos apenas humanos e que às vezes cometemos erros. Os guias irão ficando melhores com o tempo, portanto não se sinta como se precisasse tirar tudo logo de letra. Seja um pioneiro!
Tire belas fotos
Fotos bem tiradas são a primeira coisa que chama a atenção de pessoas para seu manual de reparos. É perfeitamente possível tirar fotos excelentes com equipamentos baratos. Tire um tempo antes de tirar fotos e estude nossos tutoriais de fotografia.
Incremente imagens com texto
As imagens e o texto devem enriquecer um ao outro. Imagens adicionais podem ser usadas para completar elucidações textuais e vice-versa.
Seja descritivo
Palavras vagas, como "coisa", "peça" e "treco" tornam ambíguos os manuais de reparo. Se você não sabe como se chama algo, faça uma boa pesquisa em máquinas de busca ou pergunte a alguém que conhece a matéria. Dispositivos podem esconder várias peças complexas em seu interior -- chamar uma peça de "esta coisa" não vai ajudar a ninguém!
Use imagens para guiar os leitores
O objeto deve permanecer alinhado e, se possível, ficar na mesma posição durante todo o decorrer do guia. Os leitores ficarão assim aptos a identificar mais facilmente sua posição em relação ao dispositivo que estão manejando. Se você girar o objeto, inclua uma instrução do tipo "Gire o dispositivo" ou "Vire o dispositivo 90 graus no sentido horário" para ajudar os leitores a fazer o mesmo.
Reduza ao mínimo as informações gerais
É bom ler algumas informaçõezinhas básicas: porque você está fazendo algo, quem irá se beneficiar do guia, quais preparativos devem ser realizados antes de se executar um guia. Mesmo assim, não vá além disso -- a maioria das pessoas na internet sente arrepios ao pensar que terá de ler um romance antes de poder reparar um objeto. Afinal, quando foi a última vez que você leu o manual de instruções que veio com a sua tevê?
Use e abuse do crosslink
Fazer crosslink é bom. Adicione o máximo que puder links a recursos pertinentes do site.
Mantenha a relevância em relação ao tema tratado
Por mais que achemos graça em “causos” de quando sua bisavó guardou sorvete na bolsinha (história verídica!), existem lugares mais adequados para tais histórias. E fazer isso bem no meio de um manual de reparos não é nada apropriado.
Seja informativo e não saia do tema
Acrescentar mais informações pertinentes confere um ar de confiança a seu manual de reparos.
Use um estilo singelo e não seja verborrágico
As pessoas não usarão o seu manual de reparos se não conseguirem entender sobre o que está falando.
Use o marcador certo
Você pode criar muita confusão se usar marcadores de forma inapropriada. Tire um segundinho de seu tempo para ler o significado de cada marcador antes de usá-los. Se estiver em dúvida, use o marcador padrão!
Acrescente notas de remontagem
O dispositivo talvez não precise de instruções de remontagem, se ele for simples. Mas pode ser que a remontagem requeira instruções especiais. Por exemplo, a desmontagem da tela do MacBook LCD é bastante simples. Entretanto, se você não fizer a ligação correta dos fios durante a remontagem, eles não chegarão aos pontos de conexão da placa lógica. Os leitores lhe agradecerão se você incluir pequenas dicas para ajudar na remontagem do dispositivo.
Inclua diagramas
Imagens e textos só bastam em certas circunstâncias. Acrescentar um diagrama ou dois (e dar upload nele em forma de imagem) certamente ajudará os leitores a compreender como deve ser executado o reparo.
O que NÃO deve ser feito
Não abuse de marcações
Acrescentar marcações demais deixará a imagem muito pouco convidativa para os olhos atentos dos leitores. Acrescente somente marcações suficientes para se poder identificar sobre o que você está falando, caso você ache que deva usar o recurso da marcação. Se você estiver acrescentando mais do que 4 a 5 bits de marcação, você pode dividir o trabalho em mais passos. Se estiver em dúvida, dê uma lida em alguns guias iFixit!
Não abuse de títulos para passos
Dê títulos a passos com parcimônia. Se você acrescentar guias tipo pré-requisito corretamente, você já estará automaticamente conferindo uma estrutura de navegação apropriada -- portanto, em certas circunstâncias é desnecessário dar títulos a passos.
Evite usar a primeira pessoa
Não existe o "eu" em uma equipe e não deve existir nenhum em seus textos. Você ganha mais confiança se não usar frases tais como "Eu fiz isso" em seus manuais.
Não force suas opiniões sobre a dos outros
Nós estamos aqui para ajudarmos uns aos outros e aprendermos a consertar. Reserve sua posição política e outras opiniões para um lugar mais apropriado.
Não faça uso da voz passiva
Seja direto em suas instruções ao usuário. Não caia na armadilha de trocar o sujeito pelo objeto. Ao invés disso, use verbos que expressem aquilo que você está tentando dizer.
Não faça upload de conteúdos dos quais você não é proprietário
Só faça upload de fotos e textos de sua autoria ou dos quais possua os direitos de uso.
Um agradecimento especial a esses tradutores:
100%
Udo Baingo está nos ajudando a consertar o mundo! Quer contribuir?
Comece a traduzir ›