Manual do usuário
Introdução
Em geral
Um manual do usuário, também chamado de guia do usuário, é um documento de comunicação técnica destinado a fornecer assistência às pessoas que usam um sistema específico.[1] Este documento geralmente é escrito por um redator técnico, como programadores de sistema ou gerentes de projeto envolvidos em seu desenvolvimento, ou equipe técnica, especialmente em empresas menores.
Os manuais do usuário são mais comumente associados a produtos eletrônicos, como computadores e programas.
A maioria dos manuais do usuário contém um guia escrito e imagens associadas. No caso de aplicações informáticas, é comum incluir capturas de tela de como o programa deve ser, e manuais que muitas vezes incluem diagramas simples e claramente detalhados que detalham os passos a serem seguidos pelo usuário para realizar as diferentes opções disponíveis. A linguagem utilizada deve ser simples, dirigida a um público que pode não compreender uma linguagem excessivamente técnica.
O manual do usuário é o documento que permite às pessoas que utilizam sistemas de informação compreender e utilizar as funcionalidades que os mesmos possuem. Além disso, é um guia de auxílio ao usuário final sobre o funcionamento das aplicações e soluções para os problemas mais comuns.
Seções básicas do manual do usuário
As seções de um manual do usuário[2] geralmente incluem:.
Manuais e guias para programas de computador
Os manuais e guias do usuário da maioria dos softwares aplicativos geralmente contêm todo o conteúdo detalhado na seção anterior. O Manual do Usuário Starta[3] é um bom exemplo desse tipo de documento. Porém, alguns documentos possuem uma estrutura mais fluida com muitos links internos. O Guia do usuário do Google Earth[4] é um exemplo desse tipo de manual.
O termo guia geralmente é aplicado a um documento que aborda um aspecto específico de um produto de software, por exemplo, um guia de instalação.
Em alguns softwares empresariais, onde grupos de usuários só têm acesso a uma parte da funcionalidade total da aplicação, é bastante aconselhável preparar um manual do usuário para cada grupo. Um exemplo dessa abordagem pode ser visto no manual Autodesk Topobase 2010 Help,[5] que separa o manual em guias do administrador, guias do usuário e um guia do desenvolvedor.
Referências
- [1] ↑ «Online Technical Writing: User Guides». hcexres@io.com. Archivado desde el original el 19 de agosto de 2009. Consultado el 13 de agosto de 2009.: https://web.archive.org/web/20090819022032/http://www.io.com/~hcexres/textbook/user_guides.html
- [2] ↑ «Manual de Instrucciones».: http://manualesytutoriales.com/
- [3] ↑ «Starta User Manual». Starta Development, Inc. 16 de octubre de 2006. Consultado el 13 de agosto de 2009.: http://startasystems.com/manual/
- [4] ↑ «Google Earth User Guide». Google. 4 de junio de 2009. Consultado el 13 de agosto de 2009.: http://earth.google.com/userguide/v4/
- [5] ↑ «Autodesk Topobase 2010 Help». Autodesk. Consultado el 13 de agosto de 2009.: http://docs.autodesk.com/TOPOBSCLNT/2010/ENU/Autodesk%20Topobase%202010%20User%20Documentation/index.html?url=WSfacf1429558a55de9af080101d7e8b304-7c61.htm,topicNumber=d0e342