Introduction
Uma documentação pode ser o diferencial para o sucesso de uma empresa. Por exemplo, a solução de pagamento online Stripe é conhecida entre seus usuários por sua documentação de ponta e isso contribuiu enormemente para seu crescimento e retenção.
Mas se você está aqui, provavelmente não precisa de mais convencimento, então vamos direto para as nossas 7 dicas para escrever uma documentação melhor.
Tips
Giving examples
Lembra da escola? Às vezes você não entendia uma definição, mas ao ver um caso real, você instantaneamente entendia.
Os conceitos em uma documentação funcionam da mesma forma. É bom apresentar a parte teórica, mas também é importante incluir exemplos reais.
Exhaustivity 📚
A maioria dos usuários não lê sua documentação como lê um romance ou um artigo de blog. Na Notice, 87% dos usuários não leem um artigo completo*, eles estão procurando por uma informação precisa e usarão a navegação, a barra de busca e a estrutura interna do artigo para encontrá-la.
A lição? Seus usuários não se importam se seus artigos são muito longos, mas se uma informação estiver faltando e eles precisarem entrar em contato com você. Não tenha medo de ser exaustivo, cubra todos os casos e peculiaridades.
A good search engine 🔎
Falando sobre busca? Surpreendentes 42% dos usuários utilizam a barra de busca em cada visita. Um bom mecanismo de busca deve tolerar consultas mal escritas, sinônimos e mostrar as buscas que não encontraram resultados para que você possa preencher as lacunas.
Regular updates
Uma documentação é um organismo vivo, cuide bem dela. Ela deve refletir as últimas mudanças em seu produto/serviço e os recursos devem estar atualizados (vídeos, imagens, links, ...).
Uma documentação colaborativa pode ajudar a melhorar a atualização do conteúdo.
Letting the experts talk
Cada membro de uma equipe dedicada a um tópico deve cuidar da sua parte da documentação, ou pelo menos revisar o conteúdo dedicado à sua especialidade.
Também é uma boa maneira de dar propriedade e capacitar os autores. Dar responsabilidade pelo conteúdo e relevância a pessoas específicas melhorará a qualidade geral dos artigos.
Use images and videos
Os fundamentos de um artigo devem sempre ser o seu conteúdo em texto. Porque o texto é indexável, editável e pesquisável. No entanto, adicionar vídeos e imagens torna o seu conteúdo mais divertido e mais fácil de se conectar com o leitor.
Muitas vezes é uma boa ideia fazer um vídeo de um tutorial longo, por exemplo.
Use the right tools
Na Notice, nosso objetivo é fornecer as melhores ferramentas para fazer exatamente isso, não hesite em experimentar aqui.
*considerando apenas artigos com mais de 5 parágrafos.
