Crie manuais online
Criar um guia online é um dos formatos de documentação mais populares atualmente. Com uma ferramenta profissional de criação de ajuda, você pode transformar seu projeto em um conjunto de arquivos HTML prontos para serem enviados ao seu servidor. Nenhuma programação é necessária.
Publique seu guia do usuário online e os clientes em potencial poderão explorar os recursos do seu software antes mesmo de baixá-lo. Um guia online bem elaborado gera confiança nos prospects e pode melhorar o ranking do seu site nos mecanismos de busca.
Como faço para criar um guia online no Dr.Explain?
Você não precisa conhecer HTML ou CSS para publicar ajuda online. Basta criar um projeto no menu principal e delinear os tópicos do seu futuro guia online. Se preferir não criar a estrutura sozinho, você pode usar um dos modelos prontos de guia do usuário.
Adicione seu conteúdo — texto e imagens que descrevem os recursos do seu software — usando o editor do Dr.Explain e suas ferramentas de anotação automática. Personalize o estilo do seu guia sem sair do aplicativo. Escolha entre temas prontos ou crie o seu próprio usando CSS. Você também pode ajustar a aparência do seu guia online diretamente no modo de visualização.
Um guia baseado na web deve incluir um sumário para navegação rápida, com cada página focando em um tópico específico e com links para tópicos relacionados. Ele também vem com recursos de navegação integrados, como links 'Page précédente', 'Page suivante' e de índice. Quando seu guia estiver pronto, basta exportá-lo e enviá-lo para seu servidor. O Dr.Explain cuida dessas etapas finais sem esforço.
Exemplos de manuais online criados no Dr.Explain
Você também pode ver exemplos de guias de ajuda baseados na web criados com o aplicativo.
Quais são os benefícios de usar o Dr.Explain?
Os exemplos acima mostram apenas alguns dos estilos de design possíveis. Sem escrever uma única linha de código, você pode implementar uma grande variedade de soluções de design para seu guia online. O Dr.Explain também oferece:
Design responsivo. Crie ajuda online que se adapta automaticamente a dispositivos móveis — sem necessidade de codificação.
Integração com análise da web. Adicione rastreamento para coletar estatísticas de uso, ajudando a identificar os pontos fortes e fracos de sua documentação para otimização posterior.
Suporte a código de terceiros. Incorpore widgets e outros elementos para tornar seus guias do usuário mais visuais e interativos.
Serviço de nuvem vs. Dr.Explain: uma comparação
Muitas equipes usam plataformas baseadas em nuvem (SaaS) para escrever documentação. Esses serviços oferecem benefícios claros, como acessibilidade de qualquer lugar, controle de versão integrado e suporte entre plataformas. No entanto, aplicativos de desktop como o Dr.Explain permanecem altamente relevantes. Veja como eles se comparam ao criar guias de ajuda online:
| Plataforma SaaS | Aplicativo de desktop Dr.Explain | |
|---|---|---|
| Funcionalidade offline | — | + |
| Segurança de dados | Pode sair do controle do usuário. Depende do provedor, do navegador, da política de segurança e proteção de dados do serviço de nuvem. | Está sob o controle do usuário. |
| Eficiência | Depende da conexão com a internet. | Depende do desempenho do PC. |
| Automação de anotação de capturas de tela | Depende do serviço, pode ser limitada. | + |
| Formatos de saída | Manuais online, às vezes PDF. | HTML, CHM, DOCX, PDF. |
Em certas situações, os recursos das plataformas de nuvem podem ser vistos como vantagens. A escolha entre uma solução SaaS e um aplicativo de desktop depende, em última análise, de seus requisitos específicos de segurança, acessibilidade e controle de dados.
Para que tipo de usuários o Dr.Explain é adequado?
O Dr.Explain é uma ferramenta versátil, adequada para criar documentação de usuário em qualquer área. Definitivamente vale a pena experimentar se você precisar de:
- um programa poderoso que lida com documentos de qualquer tamanho sem problemas;
- navegação fácil de usar através do seu projeto;
- busca completa;
- ferramentas de design flexíveis para personalizar a aparência da sua documentação;
- exportação direta para múltiplos formatos;
- recursos de colaboração para projetos em equipe;
- uma solução local confiável (software de desktop).
Usuários sobre a criação de guias online no Dr.Explain
'O Dr.Explain funciona excelentemente, e já convertemos nosso grande projeto de ajuda online para o seu formato'.
Jim, CNCSimulator Company
'Acho que o Dr.Explain funciona melhor para nosso setor e proporciona a 'sensação de livro' em um formato online, o que parece funcionar bem para nossos clientes que não são técnicos'.
Darryl Winder, diretor administrativo e coproprietário do projeto SmartFees
'A opção de publicar nossos documentos online também é muito útil para nós. Criamos tanto uma versão estática dos documentos que acompanha a instalação do software quanto uma versão online que está sempre atualizada com as últimas alterações'.
Are Tømmerås, Geólogo Sênior na Migris
Perguntas Frequentes (FAQ)
O guia online será otimizado para dispositivos móveis?
Sim. A documentação é construída automaticamente para ser responsiva e será exibida corretamente em telefones e tablets desde o início.
Preciso de alguma habilidade técnica para criar um guia web?
Não. Basta escrever seu conteúdo como qualquer outro documento — o Dr.Explain o transforma automaticamente em um guia de usuário HTML pronto para web, que pode ser publicado online.
O que é o formato HTML?
HTML é o formato padrão para criar páginas web. Quando você exporta o manual do usuário para HTML, obtém um guia de usuário online completo, pronto para publicação.