http://www.ehow.com.

br/escrever-manual-usuario-programa-como_22857/

Como escrever um manual de usurio para um programa

Escrito por C.D. Crowder | Traduzido por Randhal Wendel

O manual do usurio de um software quase to importante quanto o software em si. Ele ital para a aprendiza!em tanto das tcnicas "sicas quanto das mais a an#adas de um pro!rama ou aplicati o. $ormalmente os manuais so curtos% mas se so necessrios mais detalhes% eles podem ser maiores. O comprimento do manual ir depender unicamente do tipo de software e do n& el de detalhes que de em ser inclu&dos. Os usurios apreciam manuais com informa#'es concisas e fceis de encontrar% com detalhes suficientes para e itar confus'es. Nvel de Dificuldade: Fcil

Instrues

1.1
Escreva um esboo para o manual. Isso lhe dar um plano para seguir. Voc pode incluir no esboo o procedimento de instalao, a finalidade do software, descries dos menus, tarefas comuns, funes avanadas e uma seo de soluo de problemas. Inclua tamb m sub!sees em seu esboo sobre tarefas espec"ficas, como a criao de um novo ar#uivo, salvar ar#uivos e impresso de ar#uivos.

2. 2

$etalhe o processo de instalao, incluindo os re#uisitos m"nimos do computador. %ornea os re#uisitos antes do procedimento principal de instalao para #ue os usurios possam preparar seus computadores. Inclua at mesmo os passos mais bsicos para iniciantes de computador. Essas medidas podem incluir &'li#ue duas ve(es no ar#uivo de instalao& ou &Insira o '$ na unidade de '$!)*+.& ,assos t"picos de instalaes envolvem e-plicaes sobre as opes de instalao, como instalao t"pica e opes de instalao avanada, guiando o usurio passo a passo atrav s de cada tela e-ibida, como a do registro do software, adicionando c.digos ou n/meros de s rie, e como acessar o programa depois de instalado para verificar se a instalao foi conclu"da corretamente.

3. 3

%ornea uma descrio detalhada da finalidade do software. Inclua para #ue o usurio

precisa do software e como ele pode se beneficiar. ,or e-emplo, se o software lida com contabilidade, e-pli#ue tarefas de contabilidade comuns #ue o software fa( de forma mais fcil. E-pli#ue #uais funes so mais importantes para o utili(ador final. Isso dar ao usurio uma ideia de #uais funes tentar aprender primeiro. ,or e-emplo, em um software de criao musical, informe ao usurio sobre #uantas fai-as podem ser gravadas de uma s. ve(, todos os sons e ritmos inclu"dos, e os formatos dos ar#uivos #ue podem ser salvos. Inclua uma breve descrio de caracter"sticas avanadas #ue tornam esse software diferente dos outros no mercado. ,or e-emplo, o software pode ser capa( de gerar mais relat.rios ou suporta mais tipos de ar#uivos #ue #ual#uer outro programa dispon"vel atualmente.

4. 4

E-pli#ue como navegar nos menus. E-pli#ue cada item dos menus. 0odos os itens #ue no podem ser e-plicados em uma ou duas frases devem ser inclu"dos na seo 0arefas comuns do manual. Essas tarefas podem incluir a mudana de fontes e cores, impresso em diferentes formatos e tipos de ar#uivos, e organi(ao de ar#uivos e informaes.

5. 5

Escreva uma seo separada para as funes avanadas e os recursos e-tras. Esse o lugar para entrar em detalhes. ,or e-emplo, um manual do usurio para o +icrosoft E-cel pode incluir informaes sobre a criao de relat.rios, lin1s e macros. *s recursos e-tras incluem funes #ue o usurio final no espera. ,or e-emplo, o software de criao de m/sica pode vir 2unto com um leitor de m/sica. 3proveite para e-plicar os e-tras #ue podem vir com o software, ou usos e-clusivos dele.

6. 6

%ornea dicas de soluo de problemas. E-pli#ue os significados de todos os erros #ue o usurio pode encontrar, como resolver a #uesto, e como evit!los no futuro. Este tamb m o lugar para incluir informaes de contato e de a2uda.

Object 1

Dicas ( )d ert*ncias
+e o software multi,plataforma% forne#a instru#'es para cada sistema operacional% se necessrio. $unca dei-e de incluir o que oc* considera serem passos ." ios. O que pode parecer simples para oc*% pode confundir o usurio final.