Crie arquivos de ajuda CHM
Um arquivo CHM é uma coleção compactada de páginas da web reunidas em um único arquivo. Ele continua sendo um dos formatos de ajuda mais utilizados para aplicativos de software. Sem um arquivo de ajuda, seu aplicativo é apenas uma ferramenta — não um produto de software completo. Embora a lógica do seu programa possa parecer óbvia para você, como desenvolvedor, novos usuários geralmente precisam de orientação. Criar um arquivo de ajuda CHM preenche essa lacuna, garantindo que os usuários entendam e possam usar seu software de forma eficaz.
Arquivos CHM são a solução ideal para adicionar rapidamente ajuda sensível ao contexto ao seu aplicativo. A maioria das linguagens de programação modernas e ambientes de desenvolvimento incluem suporte integrado para vincular os componentes do seu software a arquivos de ajuda CHM. Esta integração usa a API HtmlHelp da Microsoft, permitindo que seu aplicativo abra tópicos de ajuda específicos ou execute pesquisas diretamente de dentro do seu programa.
Nenhuma habilidade especial é necessária. Crie seu primeiro arquivo de ajuda CHM em minutos usando o editor visual WYSIWYG. Crie e edite tópicos de ajuda sem esforço e, em seguida, configure o sumário, palavras-chave, menus e navegação com apenas alguns cliques. Use Help IDs para criar ajuda sensível ao contexto totalmente integrada.
Como faço para criar um arquivo de ajuda CHM no Dr.Explain?
Comece criando um projeto no menu principal e delineie os tópicos para seu futuro arquivo de ajuda. Se preferir não criar a estrutura sozinho, você pode usar um dos modelos de manual prontos.
Adicione conteúdo a cada tópico da sua documentação. Inclua imagens com anotações para explicar claramente os recursos do seu software. Personalize a aparência do seu arquivo de ajuda usando a visualização ao vivo do projeto. Nas configurações do projeto, você pode ajustar facilmente o estilo visual das páginas da sua documentação.
Após a exportação, você só precisará vincular o arquivo de ajuda ao seu aplicativo e incluí-lo em seu pacote de instalação. O Dr.Explain suporta a funcionalidade Help Context ID, transformando seu projeto em um sistema de ajuda sensível ao contexto totalmente funcional.
Integração
Uma ferramenta profissional de criação de ajuda permite criar arquivos de ajuda CHM prontos para integração em aplicativos Windows — sem necessidade de codificação ou conhecimento especializado. Vejamos como integrar um arquivo CHM a um aplicativo ".NET". No Dr.Explain, cada tópico tem um campo "Nome do arquivo" no painel de propriedades que você pode personalizar. No exemplo abaixo, definimos este valor como "save_button".
Abra seu aplicativo no editor de código. Para o elemento de UI que deve abrir o tópico de ajuda correspondente (a seção "Botão Salvar"), defina a propriedade HelpKeyword como "save_button":
private void HlpButton_Click(object sender, EventArgs e) { Help.ShowHelp(this, "save_button.chm"); }
É assim que vinculamos elementos de interface a tópicos específicos na documentação do usuário.
Exemplos de manuais do usuário em formato CHM criados no Dr.Explain
Abaixo estão exemplos de sistemas de ajuda sensíveis ao contexto reais construídos com o Dr.Explain.
Quais são os benefícios de usar o Dr.Explain?
O Dr.Explain é uma ferramenta de nível profissional projetada para facilidade de uso — confiável por especialistas e iniciantes. Aqui está o que o torna uma solução de referência para criar guias de ajuda de forma eficiente.
Colaboração em equipe. Embora o Dr.Explain seja um aplicativo de desktop, ele se integra à plataforma de nuvem Tiwri.com, permitindo que vários autores trabalhem juntos perfeitamente.
Fluxo de trabalho intuitivo. O processo de criação de guias é direto e não requer conhecimento técnico especializado.
Suporte multilíngue. Crie e gerencie documentação em vários idiomas e gere arquivos CHM separados para cada um — ideal para software com audiência global.
Para que tipo de usuários o Dr.Explain é adequado?
O Dr.Explain é projetado para aqueles que levam a documentação do usuário a sério — para criadores que visam construir não apenas um conjunto de instruções, mas um sistema de ajuda bem estruturado que melhora a forma como os usuários interagem com o software. Aqui estão alguns cenários onde o Dr.Explain se torna essencial:
- seu guia do usuário cresceu tanto que você precisa de pesquisa de texto completo para ajudar os usuários a encontrar rapidamente o que precisam;
- você quer aplicar estilos personalizados e dar ao seu projeto uma identidade visual única;
- você precisa colaborar com uma equipe no mesmo documento;
- você planeja exportar para múltiplos formatos como CHM, HTML, PDF e DOCX;
- você prefere experimentar uma versão gratuita antes de tomar uma decisão;
- você precisa da capacidade de incorporar código ou widgets personalizados em seu sistema de ajuda.
Usuários sobre a criação de arquivos de ajuda CHM no Dr.Explain
'O Dr.Explain nos atraiu pela grande facilidade de operação e gerenciamento de capturas de tela. Decidimos basear nosso sistema no assistente de capturas de tela, criando explicações que guiam o usuário através da tarefa. O gerenciamento de controles em cada captura de tela, juntamente com a capacidade de criar arquivos CHM e HTML, foram os pontos-chave na escolha do seu produto'.
Robert Sibilski, CEO e programador chefe da SIBORSOFT
'Esta foi a primeira vez que precisamos criar um arquivo de ajuda para qualquer projeto. Pesquisei um pouco e comparei diferentes ferramentas de criação de arquivos de ajuda CHM e o Dr. Explain pareceu atender aos meus requisitos e parecia muito fácil de usar. Com base nas avaliações de outros usuários, decidi experimentar e posso dizer sem hesitação que foi uma boa decisão'.
Rick Szasz, programador da Damselfly Solutions Inc
'Permiti que as pessoas comparassem o CHM gerado com o Dr.Explain e os outros arquivos de ajuda. A diferença foi enorme! Os comentários que recebi sobre a versão do Dr.Explain foram absolutamente positivos, e os sobre os arquivos CHM gerados pela IDE, negativos... O CHM criado pelo Dr.Explain parece perfeito, o que aumenta o valor de todo o projeto. Podemos ver o quão sério ele é'.
Michel Garcia, fundador e CEO da EZSecure
Perguntas Frequentes (FAQ)
O que é o formato CHM?
CHM é o formato de arquivo de ajuda padrão da indústria para aplicativos Windows. É o formato ideal para criar ajuda sensível ao contexto que se integra diretamente ao seu software. A funcionalidade Help Context ID transforma seu projeto em um sistema de ajuda totalmente funcional e sensível ao contexto. Leia mais sobre publicação de manuais do usuário em CHM.
O Dr.Explain pode exportar para formatos prontos para impressão?
Sim. O programa pode exportar sua documentação para DOCX e PDF — ambos ideais para impressão ou distribuição digital.
Posso personalizar a aparência dos arquivos CHM?
Sim. O programa inclui vários temas integrados e você pode editar as cores dos temas.
Ao colaborar em um documento, é possível proteger o conteúdo contra alterações acidentais por outros participantes?
Sim. Você pode bloquear tópicos específicos para evitar edição. Tópicos bloqueados tornam-se somente leitura para outros usuários. Para mais detalhes, consulte Opções de bloqueio e status.