Variáveis
Autores de documentação frequentemente enfrentam o desafio de reutilizar os mesmos fragmentos de texto repetidamente. Embora a solução usual seja copiar e colar ou redigitar manualmente, o Dr.Explain oferece uma alternativa mais eficiente: variáveis de texto.
Este recurso elimina o trabalho repetitivo e aumenta sua produtividade. Use variáveis para conteúdo frequentemente repetido, como:
- nome da empresa;
- nome do produto;
- detalhes de contato;
- números de versão do software.
As variáveis são particularmente úteis quando você precisa reutilizar texto que muda ocasionalmente — como números de versão — garantindo consistência e economizando tempo em todo o seu documento.
Como as variáveis funcionam no Dr.Explain?
Digamos que você precise incluir repetidamente conteúdo como números de versão de software ou endereços de e-mail em todo o seu guia. Em vez de digitá-los toda vez, basta criar uma variável. Da próxima vez que precisar desse texto, simplesmente selecione a variável apropriada da sua lista.
Quando você precisar atualizar informações em todo o seu projeto — como um número de versão ou e-mail de contato — basta alterar o valor da variável uma vez. O Dr.Explain atualiza automaticamente todas as instâncias em sua documentação.
Exemplos de documentação criados com o Dr.Explain
Esta página contém links para guias de usuário reais desenvolvidos no Dr.Explain. Abaixo você encontrará capturas de tela demonstrando as capacidades do programa.
Quais são os benefícios de usar o Dr.Explain?
O Dr.Explain elimina o trabalho manual repetitivo — especialmente quando sua documentação contém muito texto repetido. Com as variáveis, você nunca mais precisará duplicar conteúdo manualmente.
Manutenção de conteúdo fácil. As variáveis tornam simples manter as informações atualizadas em toda a sua documentação.
Mais criatividade, menos rotina. As variáveis removem o tédio de editar os mesmos dados em vários lugares. Gaste menos tempo com digitação repetitiva e mais tempo melhorando seu conteúdo.
Documentação personalizada. Use regras de exibição condicional para mostrar conteúdo diferente para diferentes grupos de usuários, adaptando a experiência para cada público.
Para que tipo de usuários o Dr.Explain é adequado?
O Dr.Explain é uma ferramenta profissional de criação de ajuda que funciona para organizações de todos os tamanhos — desde grandes equipes até autores individuais, e de iniciantes completos a profissionais experientes. Suas ferramentas intuitivas não exigem treinamento prolongado, e os modelos incluídos ajudam você a criar sistemas de ajuda refinados mais rapidamente. É uma escolha confiável quando você precisa:
- atualizar regularmente detalhes de contato, números de versão ou blocos de texto inteiros em sua documentação;
- permitir que vários autores colaborem no mesmo documento;
- escolher entre opções de licenciamento flexíveis;
- verificar ortografia em vários idiomas;
- personalizar o design e o layout da sua documentação.
Usuários sobre trabalhar com variáveis no Dr.Explain
'Adoramos as variáveis no Dr.Explain, pois elas nos permitem versionar nossa documentação em um só lugar. Os usuários podem ver facilmente se estão olhando para a versão mais recente do documento'.
David Swindon, CIO da Trustco Group Holdings
'Como o Dr.Explain é projetado especificamente para documentação, ele tornou todo o processo muito mais fácil. Por exemplo, pesquisa, indexação, hyperlinks, etc'.
Mike McLoughlin, o desenvolvedor único da Champion Software
Perguntas Frequentes (FAQ)
Existem tutoriais em vídeo para o seu programa?
Sim. Você pode encontrá-los em nosso canal do Youtube.
O Dr.Explain pode verificar ortografia?
Sim. Saiba mais no tópico Verificação ortográfica.
O programa inclui modelos de documentação prontos?
Sim.
Existem limites para quantos tópicos aninhados posso criar?
Não há limites.
Posso usar meu próprio código CSS para estilizar a documentação online?
Sim, você pode personalizar completamente o design com CSS.