Como criar um arquivo de ajuda

Embora muitas vezes são ignorados por usuários de computador, arquivos de ajuda fornecem informações essenciais sobre como utilizar a aplicação de software para o qual eles estão associados. Ao clicar em "Ajuda", um usuário pode obter uma visão geral dos recursos do programa, uma descrição da tela que está assistindo, instruções sobre como usar o programa para executar determinadas tarefas ou listas de leitura perguntas mais frequentes sobre programa e as suas respostas. Faça um arquivo de ajuda requer tanto a capacidade de funcionar com aplicações de software, bem como a capacidade de explicar as coisas de modo que os usuários possam entender. Abaixo está um guia de como fazer um arquivo de ajuda é apresentada.

passos

1

Obter uma cópia do software que você está prestes a documentar. Se possível, você também deve obter uma cópia das especificações programa escrito, mas não a todos os desenvolvedores de software que trabalham com eles. Em alguns casos, o programador desvia-se especificações, com base no curto espaço de tempo que tem que desenvolver ou porque não é capaz de codificar uma característica particular.

2

Obter uma ajuda ferramenta de criação. Quando você pode criar um arquivo de ajuda com a mão, com um formato enriquecido (.rtf), texto, a maioria dos autores arquivos de ajuda usando um aplicativo de software para escrever arquivos de ajuda, como o RoboHelp, Ajuda e Manual doc-To-Help, alargamento MadCap ou HelpLogix. A maioria das ferramentas para ajudar a autora inclui um editor de texto ou trabalhar com um programa de processamento de texto como o Microsoft Word e fornecer a interface de usuário que permite que o autor vê como o arquivo de ajuda será. Algumas ferramentas para ajudar o autor também inclui editores gráficos para criar imagens e incluídos no arquivo de ajuda.

3

Criar o suporte de arquivo de projeto. Sua ferramenta para ajudar os autores criará o apoio arquivo de projeto para você, com base no nome de arquivo que proporções e outras informações. O arquivo de projeto de Ajuda principal contém informações sobre outros ficheiros, incluindo o conteúdo do arquivo, um índice, um ou mais arquivos de imagem e outros arquivos.

4

Ajuste o tamanho da janela de ajuda. A menos que você está escrevendo o arquivo de ajuda para exibir na busca do usuário da Web, o arquivo de ajuda será exibido em sua própria janela. Sua ferramenta de ajuda permite ajustar as dimensões verticais e horizontais da janela para um tamanho que permite que o usuário leia o arquivo de ajuda sem suporte com o próprio aplicativo.

5

Escrever tópicos de ajuda. Para fazer isso você precisa verificar as especificações e do próprio programa. Como você criar cada problema, a ferramenta ajuda a adicionar o arquivo de ajuda por parte de conteúdo e índice.

6

Ele inclui imagens, se necessário. Muitas características de determinado programa são melhor explicadas por uma combinação de gráficos e texto. Você pode criar screenshots com qualquer aplicativo que vem com sua ferramenta de ajuda ou um pedido separado.

7

Criar um mapa de arquivo, se necessário. Alguns programas incluem botões "Help" de modo que quando o usuário clica no item é exibido no arquivo de ajuda e descrever especificamente como essa tela funciona.

8

Compilar o ficheiro de ajuda. Ao compilar o arquivo de ajuda para ser incluído no programa é criado.

9

Experimente o arquivo de ajuda. Uma vez que o arquivo é compilado é necessário que você verifique se tudo está funcionando corretamente.

10

Dê o desenvolvedor arquivo de ajuda para inclusão no programa.

dicas

• Em empresas com grandes departamentos técnicos, muitos autores arquivos de ajuda pode ser atribuído a um projeto, alguns tópicos em áreas específicas, outros que acreditam screenshots e um diretor que revê periodicamente o trabalho. empresas menores provavelmente vai contratar um único arquivos autor de ajuda.

Coisas que você precisa

• arquivo de Ajuda Software
• screenshots editor de software