Sonat

Here you have access to some useful articles provided by Sonat.

Articles

V1.0.0

Como escrever um tutorial para o seu software: um guia passo a passo

<h1>Como escrever um tutorial para o seu software: um guia passo a passo</h1><figure class="image"><img src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/d0b5c311-06f0-49f9-87b7-1dea92b0bf3b.webp" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/d0b5c311-06f0-49f9-87b7-1dea92b0bf3b.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/d0b5c311-06f0-49f9-87b7-1dea92b0bf3b.webp?width=500 500w" sizes="100vw" width="500"></figure><p>Depois de criar um software que resolve um problema específico, é hora de compartilhar essa solução como um tutorial com o maior número de pessoas possível. Criar essas instruções manualmente ou usar um criador de tutorial não apenas torna seu software mais acessível a outras pessoas, mas também aumenta sua longevidade e o número de maneiras pelas quais outras pessoas podem usá-lo.</p><p>Dito isto, <a href="https://sonat.com/training-documentation-software/">a criação de tutoriais</a> é complexa e requer planejamento e execução cuidadosos. Esta postagem do blog explicará como escrever um tutorial para o seu software de maneira eficaz e eficiente.</p><p>&nbsp;</p><h2 id="descrevendo-seu-tutorial">Descrevendo seu tutorial</h2><p>&nbsp;</p><p>A primeira coisa que você precisa fazer quando se senta para escrever um tutorial é delinear todo o seu tutorial e ter certeza de que sabe o que está tentando ensinar às pessoas. Antes de criar o tutorial, você deve entender o que seus leitores devem receber. Você também precisa saber quais problemas exatos seu software resolve e como seus leitores podem colocar esse conhecimento em prática no dia a dia.</p><p>Descrever claramente o seu manual de treinamento tornará o processo de redação mais simples. Também tornará mais fácil editar seu tutorial posteriormente, se precisar fazer alterações ou atualizações.</p><p>&nbsp;</p><h2 id="conhe-a-seu-p-blico">Conheça seu público</h2><p>&nbsp;</p><p><img class="image-style-align-right"><img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b155b17f-42fa-4bbd-ad09-801e91731bfb.webp" alt="conheça seu público para escrever um tutorial online" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b155b17f-42fa-4bbd-ad09-801e91731bfb.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/b155b17f-42fa-4bbd-ad09-801e91731bfb.webp?width=350 350w" sizes="100vw" width="350"> Ao escrever um tutorial, você precisa deixar bem claro para quem o está escrevendo. Você precisa entender as experiências anteriores dos usuários, o conhecimento atual e o que eles esperam ganhar com você. Se você escrever um tutorial que presume que seus leitores não sabem absolutamente nada, você não conseguirá envolvê-los e eles perderão o interesse. Por outro lado, se você criar um guia que pressupõe que seus leitores sabem tudo, você não poderá desafiá-los ou fornecer-lhes novas informações que possam usar.</p><p>Tudo isso levará a uma experiência ruim e a uma falsa compreensão do que o seu software faz. E é aqui que se revela a importância de conhecer o público.</p><p>&nbsp;</p><h2 id="decida-um-formato-e-uma-plataforma-">Decida um formato e uma plataforma.</h2><p>&nbsp;</p><p>A próxima coisa que você precisa considerar ao escrever um tutorial é qual formato e plataforma você usará. Você pode escolher vários formatos, incluindo vídeo, áudio, texto ou uma combinação dos três. Você também pode publicar seu manual de treinamento em várias plataformas, incluindo sites, blogs, canais de mídia social e plataformas de cursos.</p><p>Por exemplo, se você usar texto e imagens, poderá publicá-los em um site, blog ou como parte de um curso online maior. Se decidir usar um vídeo, você pode enviá-lo para o YouTube ou Vimeo ou transmiti-lo diretamente do seu site. E se você optar por usar uma combinação dos três, poderá fazer upload do formato de imagem para uma plataforma e do áudio para outra e, em seguida, vinculá-los para que sejam fáceis de seguir.</p><p>&nbsp;</p><h2 id="encontrando-as-imagens-certas">Encontrando as imagens certas</h2><p>&nbsp;</p><p>Um dos componentes essenciais de qualquer tutorial são as imagens. Embora não precisem ser as imagens mais profissionais ou de alta qualidade do mundo, elas precisam ser relevantes para o que você está tentando ensinar e fáceis de entender para seus leitores. <img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/a2901b07-5e80-4bec-a82c-491606c7641f.webp" alt="encontre a imagem certa para o seu tutorial online" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/a2901b07-5e80-4bec-a82c-491606c7641f.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/a2901b07-5e80-4bec-a82c-491606c7641f.webp?width=350 350w" sizes="100vw" width="350"></p><p>Existem algumas maneiras de encontrar imagens para o seu tutorial. Você pode criá-los você mesmo, comprá-los em uma biblioteca de imagens ou encontrar imagens Creative Commons que podem ser usadas e modificadas gratuitamente. Você também pode usar capturas de tela do seu software.</p><p>No entanto, antes de obter imagens aleatórias do seu software, você deve considerar seus direitos sobre essas imagens. Em alguns países, tirar fotos de outro site e usá-las por conta própria é ilegal sem a permissão do proprietário do site. Em outros países, é legal, mas ainda é antiético.</p><p>&nbsp;</p><h2 id="escreva-o-tutorial">Escreva o tutorial</h2><p>&nbsp;</p><p>Agora é a hora de sentar e escrever o tutorial. Você pode fazer tudo de uma vez ou dividir em pedaços menores. A melhor maneira de escrever o tutorial é ler seu esboço e expandi-lo.</p><p>Ao escrever o tutorial, você deve lembrar que ele não é apenas para pessoas que não sabem absolutamente nada sobre o assunto. É também para pessoas que possuem algum conhecimento do assunto, mas desejam aprender mais. Ao escrever o tutorial, use cabeçalhos, subtítulos e palavras em negrito para destacar informações importantes.</p><p>&nbsp;</p><h2 id="obtenha-feedback-dos-clientes-e-mantenha-o-tutorial-atualizado">Obtenha feedback dos clientes e mantenha o tutorial atualizado</h2><p>&nbsp;</p><p><img class="image-style-align-right" src="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/062d854b-30b2-40f1-b982-ad658a369f1a.webp" alt="Obtenha feedback dos clientes e mantenha o tutorial atualizado" srcset="/api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/062d854b-30b2-40f1-b982-ad658a369f1a.webp?width=320 320w, /api/document/image/76d874ef-ee68-4a00-952c-78af67ead707/4845a450-3161-45c7-9f20-f05167cd06cf/062d854b-30b2-40f1-b982-ad658a369f1a.webp?width=350 350w" sizes="100vw" width="350"> Depois de escrever seu tutorial online ou em papel e publicá-lo, você precisa garantir que ele esteja visível para seus clientes. Você pode fazer isso promovendo-o em seu site e canais de mídia social, adicionando-o às suas campanhas de email marketing e pedindo às pessoas que têm acesso ao seu público que o compartilhem.</p><p>Quando as pessoas começarem a visualizar e ler seu tutorial, você poderá obter feedback delas sobre como é fácil de entender e usar e como pode ser melhorado. Esse feedback é crucial para tornar seu tutorial o mais fácil de entender possível e também ajudará você a identificar possíveis erros ou equívocos. Manter o tutorial atualizado também garantirá que ele permaneça relevante e valioso para seus leitores.</p><p>&nbsp;</p><h2 id="aqui-est-o-mais-algumas-dicas">Aqui estão mais algumas dicas</h2><p>&nbsp;</p><p>Por fim, você pode seguir algumas dicas e truques para garantir um ótimo tutorial, fácil de entender e usar. Isso inclui ler o manual de instruções em voz alta, colocar-se no lugar dos leitores e imaginar que você é totalmente novo nesse tópico. Em seguida, peça a outra pessoa para revisar seu tutorial e ajudá-lo a identificar quaisquer erros ou áreas que possam ser melhoradas.</p><p>&nbsp;</p><h2 id="conclus-o">Conclusão</h2><p>&nbsp;</p><p>As pessoas precisam entender como usar o seu software; um tutorial é a melhor maneira de conseguir isso. É por isso que é essencial criar um manual fácil de seguir e bem estruturado que inclua todas as informações relevantes. Dessa forma, seus leitores poderão utilizar seu software com facilidade.</p><p>A melhor maneira de escrever um tutorial para o seu software é escrever esboços e garantir que você sabe o que está tentando ensinar às pessoas. Conheça o seu público, decida um formato e uma plataforma, encontre as imagens certas, escreva o tutorial, obtenha feedback dos clientes e mantenha o tutorial atualizado.</p><aside class="template-box note-template-box" variant="note"><div class="template-box-title">&nbsp;</div><div class="template-box-description"><p>Comece a criar seu tutorial facilmente com <a href="https://sonat.com/training-documentation-software/">o software de documentação de treinamento da Sonat</a> .</p></div></aside>

As 13 principais regras simples, mas poderosas para a criação de manuais do usuário

Escreva um manual profissional usando modelos gratuitos de manual do usuário

O que exatamente é um manual do usuário e por que é tão importante?

Como criar um manual do usuário profissional

Por que você deveria parar de escrever manuais do usuário com o Microsoft Word

Documentação interna, externa, de produto, de processo, técnica e de usuário