domingo, 17 de dezembro de 2017
DVD
ConteÚdo
DOWNLOADS
Interação
dicas aleatórias
Artigos

Arquivos de ajuda on-line: indispensáveis em sistemas profissionais

Você realmente sabe fazer um arquivo de ajuda on-line? Veja como fazer e acionar um arquivo desse tipo.

Por: Roberto Amaral Fernandes (amaral@ativoaccess.com.br)
Publicado: 12/03/2004  Visitas: 3767
Dificuldade: Intermediário

Indicação de Artigo  Imprimir

Arquivos de Ajuda – veja como fazer uma ajuda on-line para o seu aplicativo usando Help Express®
Roberto Amaral Fernandes

Introdução
Sim, nós temos arquivo de ajuda on-line!

Faça dessa frase seu lema: a partir de agora providencie arquivos de ajuda on-line para todos os seus sistemas. É um grande passo na direção de tornar mais profissional o aplicativo que você desenvolve, e um complemento fundamental aos processos de treinamento do usuário, de registro de patente, de homologação e de licitações comerciais.

Um bom arquivo de ajuda on-line é um acessório indispensável que empresta ao produto final uma aparência elegante e de qualidade. Mas, não é fácil produzir um. A confecção de um arquivo de ajuda requer planejamento, paciência e treino e o trabalho se inicia junto com o desenvolvimento do sistema, quando tabelas, consultas, formulários e outros objetos ainda estão na “bancada de trabalho” do Desenvolvedor. Nessa fase é possível antever as dúvidas e os prováveis enganos do usuário, tópicos que o Desenvolvedor contemplará no arquivo de ajuda.

Também nessa área, sempre é possível inovar: por que não incluir resumos, revisões e até mesmo questionários no arquivo de ajuda? Alguma coisa do tipo: “... se você acabou de ler as instruções e deixou de responder corretamente qualquer das perguntas abaixo, não use o sistema ainda. Recomendamos uma nova leitura...”

O arquivo de ajuda leva uma grande vantagem sobre o manual impresso, porque é on-line e está disponível a todos os usuários o tempo todo. Esses usuários podem fragmentar a leitura da ajuda na medida em que as dúvidas aparecem na operação do sistema. Esta é uma das razões pelas quais devemos construir arquivos de ajuda bem divididos em tópicos e com palavras chaves definidas. Se você quiser um bom exemplo veja o arquivo de ajuda do Sistema de Imposto de Renda distribuído no Brasil. Imagine só o desafio de se passar aquela quantidade de informações para um público completamente diversificado!

Veremos a seguir as ferramentas necessárias ao trabalho e como obtê-las.


Ferramentas de construção de Help

Existem várias ferramentas auxiliares para construção de arquivos de ajuda. Nesse artigo usaremos:


  • Arquivo de Ajuda: Help Express 3®, versão 3.0.2.285 ou superior, da Chainware Co. Faça download de uma cópia shareware no site www.chainware.com ou baixe uma cópia na seção de downloads da revista. Instale os dois arquivos a seguir:
    - Hcwsetup.exe
    - HelpExpr.exe
  • Imagens: Microsoft Paint® que acompanha todas as versões do MS Windows®. Você captura as imagens da tela com a tecla Print Screen, cola e recorta no Paint e finalmente cola na tela do tópico.
  • Textos sem formatação: Microsoft Bloco de Notas® que acompanha todas as versões do MS Windows®. Todo e qualquer texto copiado deve ser colado antes no Bloco de Notas e depois na tela de tópico.
  • Textos especiais: Xara WebStyle Version 1.2® ou superior, da Xara Co. Faça download de uma cópia trial (15 dias) no site www.xara.com. Para colar os textos produzidos use a mesma técnica de imagens do Paint.
  • Observação: as versões citadas são as que eu disponho, podendo estar atualizadas nos sites indicados. Você também pode substituir esses aplicativos por outros de seu conhecimento.



Estrutura básica de um arquivo de ajuda

Se você tem uma visão geral do conteúdo da ajuda, ótimo, basta organizar essa visão em tópicos, colocar todos os itens no tópico de contexto e começar a digitar, trazendo as imagens necessárias e colando os respectivos links. A idéia para este artigo é fazer um arquivo de ajuda básico, usando recursos básicos do Help Express 3 para que você possa ir incrementando à medida que novas técnicas forem incorporadas. Não é nossa missão um aprofundamento no Help Express 3, mas podemos adiantar que a interface do mesmo é intuitiva e de fácil aprendizado. Confira na figura 1.

Se você não tem idéia por onde começar, dê uma boa olhada no menu principal do seu aplicativo. A tela inicial poderá se tornar o tópico de contexto onde serão feitas as apresentações do sistema, a finalidade, as principais virtudes, cuidados especiais a serem observados, créditos, enfim o início de um diálogo com o leitor. Cada opção do menu principal poderá ser um tópico no arquivo de ajuda, e os submenus poderão ser subtópicos acionados por links.

É muito comum que o sistema contemple vários departamentos da empresa a que se destina e, portanto, o arquivo de ajuda deverá ser lido por diversas categorias de empregados, como por exemplo, pessoal da produção, da contabilidade, de vendas, da administração, etc. Nesse caso é muito interessante fragmentar a ajuda em partes destinadas a esse público e colocar no início do arquivo um texto genérico a ser lido por todos. Os links farão o resto do trabalho de direcionamento de tópicos. Essa técnica evitará que todos tenham que ler tudo, o que seria muito desmotivador. O leitor é direcionado para assuntos de seu específico interesse.

Vamos examinar a estrutura do arquivo de ajuda do aplicativo Catalogue mostrado a seguir. Inicie o Help Express 3 e abra o arquivo Catalogue.he3 fornecido pela revista para download. Observe na figura 2 que o primeiro tópico sempre será o tópico de contexto.

Figura 1 - O arquivo de ajuda on-line do Catalogue

Figura 2 - Estrutura de tópicos do arquivo de ajuda Catalogue.he3

Passo a passo da montagem e compilação de ajuda

  • Criando um tópico: o primeiro tópico é padrão, mas você poderá adicionar tópicos clicando em

  • Criando opções em um tópico: Essas opções serão usadas em tempo de programação. Selecione o tópico alvo e clique em [img]help/arquiv4.jpg[img].

    Será fornecida a seguinte caixa de diálogo:

    Figura 3 – Caixa de diálogo para configurar opções de tópicos
  • Editando o tipo de tela: Onde você especifica opções para as telas do arquivo de ajuda. Clique em
    e escolha as cores das telas com um clique em cada cor, a posição da tela, o título do arquivo de ajuda, os botões e muito mais.


    Figura 4 – Caixa de diálogo para especificar o tipo de tela

  • Criando um frame: Um frame é idêntico a um cabeçalho do MS-Word®. Clique em
    e digite o conteúdo do frame no box:
    [frame] Your text here [/frame]

  • Criando um link de tópico: Primeiro crie o tópico e depois digite e selecione o texto do link conforme abaixo.

    Clique então em
    e preencha o campo Topic na caixa de diálogo Create link:

    Figura 5 – Caixa de diálogo Create Link

  • Criando um link pop up: proceda da mesma maneira como para criar um link de tópico: primeiro crie um novo tópico e digite todo o conteúdo podendo inclusive colar imagens. Depois disso, já no tópico de chamada digite e selecione o título, clique no botão
    e preencha a caixa de diálogo da figura 5, apenas informando como Type: Popup Link.
  • Passando opções de projeto: Na barra de ferramentas do Help Express 3 clique em Project » Options. Na janela Project options, preencha os campos e selecione as opções mais apropriadas ao seu sistema, como na figura 6:

    Figura 6 - Caixa de diálogo Project Options
  • Compilando o arquivo de ajuda: Na barra de ferramentas clique em Project e depois em Compile, ou tecle F9. Pronto, o Help Express 3 irá gerar o seu arquivo de ajuda conforme mostrado na figura 7:

    Figura 7 - Arquivo de ajuda compilado pelo Help Express 3

    Ajuda de contexto (ligando um campo a um tópico de ajuda)
    Vamos ver agora:
  • Como abrir um arquivo de ajuda a partir de um botão de comando do MS-Access®: digite o seguinte código em um botão de comando chamado Ajuda:

    Private Sub Ajuda_Click()
    Dim stAppName As String
    stAppName = "Winhlp32.exe c:\Catalogue\Catalogue.HLP"
    Call Shell(stAppName, 1)
    End Sub


  • Como ligar formulários e campos de formulários a um tópico de ajuda: veja o número do contexto no tópico Catalogar do arquivo de ajuda Catalogue.he3 e a propriedade do formulário no MS-Access®: Se o foco estiver no formulário ou em qualquer campo do mesmo e F1 for clicado, o MS-Access® aciona o tópico Catalogar da ajuda.


    Figura 8 - Propriedades de um formulário do MS-Access®

    Ajuda em Msgbox (ligando mensagens com opção de ajuda)
    A função MsgBox abaixo oferece ao usuário a opção de acionar o arquivo de ajuda no contexto 4000. Veja:


    MsgBox "Nenhum arquivo está selecionado na pesquisa em Explorar ! @ Sugestão:
    Leia Pesquisar Arquivos na Ajuda do Sistema. @ Depois refaça a consulta !", vbExclamation,
    , "C:\Catalogue\Catalogue.hlp", 4000


    Eis o resultado:

    Figura 9 - Caixa de mensagem com opção de visualizar contexto de ajuda



    No Access 2000 não é possível obter-se o efeito de mensagens da Figura 9, que está disponível somente no Access 97. Para contornar o problema usei a função abaixo que foi disponibilizada pela equipe técnica da revista Fórum Access:


    Function FormataMsgBox(Prompt As String, Optional Buttons As VbMsgBoxStyle = vbOKOnly, Optional Title As String = vbNullString, Optional HelpFile As Variant, Optional Context As Variant) As VbMsgBoxResult

    If IsMissing(HelpFile) Or IsMissing(Context) Then

    FormattedMsgBox = Eval("MsgBox(""" & Prompt & """," & Buttons & ", """ & Title & """)")

    Else

    FormattedMsgBox = Eval("MsgBox(""" & Prompt & """," & Buttons & ", """ & Title & """, """ & HelpFile & """, " & Context & ")")

    End If
    End Function


    A função foi acionada da seguinte maneira:


    FormataMsgBox "Nenhum arquivo está selecionado na pesquisa em Explorar ! @ Sugestão: Leia Pesquisar Arquivos na Ajuda do Sistema. @ Depois refaça a consulta !", vbExclamation, "Catalogue - Catalogador de Arquivos", "C:\Catalogue\Catalogue.hlp", 4000




    Não é só no arquivo de ajuda que podemos passar instruções ao usuário. O MS-Access® fornece outros meios:

  • Preenchendo o campo descrição na estrutura da tabela e habilitando a barra de status no menu Inicializar:

    Ilustração 10 - Estrutura de uma tabela do MS-Access®


    Figura 11 - Barra de status do MS-Access® habilitada em Ferramentas/Inicializar/Mostrar Barra de Status

  • Preenchendo o texto das dicas sobre controles na caixa de propriedades:



Figura 12 - Caixa de propriedades do botão de comando CarregaDrives. Destaque para Texto das dicas sobre controles

Eis o resultado:



Conclusão

Os arquivos de ajuda estão relacionados ao treinamento de usuários. Quando se fala em treinamento eu sempre me lembro da estória do maquinista novo que foi aprender o serviço com o maquinista mais velho na ferrovia. Antes de partir, o maquinista mais velho pegou um martelo de madeira e, pacientemente, dando a volta em torno da locomotiva, dava uma leve batida em cada roda que encontrava assim procedendo até contornar o trem inteiro. Nada entendendo o maquinista novo quis saber o porquê daquela estranha atividade. Foi quando o maquinista velho falou: - Faço isso há 30 anos e não sei o porquê, e você chegou agora e já quer saber!

Com sistemas que não estão bem documentados acontece algo bem parecido: usuários adotam alguns procedimentos sem saber o motivo. Depois esses usuários vão embora da empresa, pois ninguém é eterno, e chegam novos usuários que não são devidamente treinados pelos antigos. Nesse ponto começa o dilema do Desenvolvedor: surgem erros, pedidos de manutenção, perda de dados importantes, sistemas importantes ficam travados e assim por diante. Será que muita coisa não poderia ser evitada com bons arquivos de ajuda que explicassem, entre outras, o porquê das coisas?

Links relacionados:

Artigos relacionados:
  Nenhum artigo relacionado

 

Compre DVD
     Compre o nosso CD - R$ 70,00

 

 

   Copyright © Ativo Access 2003 - 2017- Todos os direitos reservados   Política de Privacidade | Fale conosco