6.3 Dicas

Dicas para utilização do programa DMHelp

HTML Single Page

Em documentos grandes gere saídas apenas HTML Single Page enquanto você estiver "construindo" o seu manual.

Isso porque as saídas RTF embutem as imagens nos documentos e nas saídas HTML Multi Page são geradas várias páginas o que, em ambos os casos, "gasta-se" mais tempo. Gere estes dois formatos apenas no final da construção dos seus Manuais.

Apague as conversões

Apague os arquivos convertidos, de vez em quando (os gerados, normalmente, no diretório ...\Converted), pois é comum que durante a construção das páginas você mude o nome das mesmas e, como nas saídas HTML Multi Page é gerado um arquivo para cada página correspondente declarada, poderão ir ficando páginas antigas já que o DMHelp não deleta nenhum arquivo que não vá reconstruir.

Dicas para elaboração de manuais

Defina a estrutura

Antes de "sair" escrevendo, pense um pouco sobre e "rabisque" a estrutura desejada do seu documento.

Idealize quais serão os capítulos, e suas sub-páginas e se mentalize fazendo um "discurso" sobre o assunto.

Isso fará você ficar mudando a estrutura do seu documento antes de escrevê-lo pois mudanças após a escrita são mais trabalhosas.

Quebre em arquivos

Se seu documento for muito grande "quebre-o" em vários arquivos e os inclua utilizando um documento principal.

Assim fica mais fácil a identificação de onde se fazer alterações, ou seja, você vai direto no arquivo, ao invés de ficar scrollando a tela do seu editor até chegar no ponto desejado.

Utilize, por exemplo, um arquivo para suas macros, outro para definições principais (como cabeçalhos e redapés, por exemplo), outro para o Índice, Capa, etc.

Utilize as macros

Elas estão aí para simplificar.

Faça o índice por último

Isso evita que você o fique modificando "toda hora" até o seu aspecto final.

Não use muitas cores

O "negócio" é "preto no branco". É mais elegante e mais fácil de ler.

Imagens originais

Procure não contrair (ou expandir) as imagens que você utilizar. Isso normalmente causa distorções e descoforto de leitura. Gere, sempre que puder, as imagens no tamanho a ser aplicado.

Sites recomendados

Edit Plus

Use o EditPlus (www.editplus.com), bom editor de arquivos texto com recursos de macros de teclado, auto-completion e high-light syntax. Em:

C:\Program Files\DMHelp\Examples\EditPlus

existem arquivos que você pode utilizar para agilizar a digitação de seus documentos se você utilizar o Edit Plus.