Como fazer um manual?

[joao]

Ola pessoal,

Gostaria de saber se alguém tem algum manual de como fazer um manual!

Imagina que eu tenho um Projeto que engloba HW e SW e eu gostaria de criar o manual do mesmo.

Alguém tem algumas dicas/manuais/orientações sobre isso?

Ou simplesmente vai vendo o que se fez e vai adicionando ao manual até achar que ele está bom?

Qualquer dica é bem vinda!

[]'s

[edison]

Creio que o primeiro passo é adquirir um manual de algum produto/projeto equivalente da concorrência.

Aos poucos ir montando o seu tomando o outro como um roteiro.( não vale ctrl C + ctrl V )

Baseado na minha experiência com implantação de equipamentos sugiro o seguinte.

Definir se o manual é para uso de pessoal técnico ,promocional ou operacional ou todos unificados em capítulos.

Se for promocional ,deve salientar bem as vantagens comerciais ,ou seja, produtividade, segurança e durabilidade sem se prender a muitos termos técnicos complexos. Mostre que é INVESTIMENTO e não custo.
Quem vai ler é o cara que decide a compra.

Se for técnico deve conter todas as caracteristicas envolvidas como consumo,dimensões,lay-out ,dados de programação, lista de peças e equivalências, etc. Resumo do circuito em blocos ajuda.Mas cuidado prá não entregar o "ouro" se não seu projeto pode ser copiado. Uma cópia em CD ( bem etiquetado) facilita o arquivamento técnico . Uma capa em cor bem chamativa (roxa, rosada com florzinhas.....) ajuda a localizar no meio da bagunça da oficina.
Dê destaque no final a uma forma de "suporte técnico" (telefone ,emala etc)

Se for operacional vc deve ter em mente que quem vai ler é o "cara mais burro do mundo" então deve ser bem ilustrado e em linguagem simples e cercando todas (ou quase) rotinas envolvidas. Lembre que esse material ficará junto ao equipamento e deve conter um capítulo para consulta rápida. Uma tabela resumida de parâmetros e falhas ajuda muito. Se possivel faça uma cópia prá cada operador estudar ,conforme a complexidade ofereça um treinamento "in-loco", garanto que vc vai aprender mais do que eles.

A apresentação tb é importante, uma encardenação plástica, papel de qualidade ,ilustrações coloridas e detalhadas mostram seriedade. E nunca se esqueça de incluir em destaque a SUA MARCA !!

Espero ter ajudado.

Té mais...

[edison]

Saiu duplicada...desculpe.

[ernande_filho]

João, deve existir alguma norma para elaboração de um manual.

Se eu descobrir algum dado, posto aqui.

mas por enquanto, vai no "CTRL+C" "CTRL+V" com as devidas alterações!

[joao]

Valeu!

Ajudou bastante...

To vendo que eu vou ter que fazer os 3 manuais!

Mas vou começar com o operacional, para poder mostrar ao pessoal da venda como será a cara do produto. Pois ainda temos que decidir o layout to programa, como por exemplo, aonde que se coloca os botoes e etc...

Tava vendo também sobre esse promocional, mas ainda vou deixar mais para adiante este...

Só para saber, vcs estão usando o microsoft word mesmo para isso? Como fica as páginas dai? Não tiveram problemas em fazer uma vez que vai ser usado os dois lados do papel e a primeira página será a última página também... (Consegui explicar o problema? )

[]'s

[Doth]

Cara tive uma cadeira de engenharia de software que falava que so é considerado software se tem manual.

Acho que a coisa mais importante de um manual é que ele tem que ser focado no usuario, não adianta colocar jagões tecnicos que o usuario não entenda.

Uma boa coisa é ver o manual da aplle, pra ver como é focado no usuario.

Acho que no word tem um aplicativo de fazer documentaçao.

[edison]

Só para saber, vcs estão usando o microsoft word mesmo para isso? Como fica as páginas dai? Não tiveram problemas em fazer uma vez que vai ser usado os dois lados do papel e a primeira página será a última página também... (Consegui explicar o problema? )

[]'s

Cria no MS Word e depois converte prá PDF. Aqui tem um programa gratis prá isso.

http://superdownloads.uol.com.br/downlo ... dfcreator/

Quanto a usar os dois lados da folha é questão de gosto, veja o que fica mais confortável prá ler.
Não esqueça de deixar folhas (uma ou duas) em branco para anotações futuras.
Caso haja alguma ateração de programa (parâmetros de campo) deixe uma coluna prá anotações junto com a tabela de parâmetros defaut ,isso facilita quando se reseta o equipamento e não se lembra dos parâmetros antigos.

Uma boa dica seria vc conseguir um manual da WEG ou outro, ( baixe na net) com ele vc vai ter uma boa idéia de layout de manual técnico em PDF

Por exemplo: http://catalogo.weg.com.br/files/artigos/1-492.pdf

Té mais...

[renatokodaira]

Opiniao pessoal:

Eu gosto de manual com espiral prendendo as paginas. Fica mais facil de se ler quando se estah tentando usar o equipamento, pois nao fecha sozinho e voce perde a pagina que estava lendo como com os manuais em brochura.

Outra opçao sao as folhas soltas para se prender em pastas, assim pode-se arquivar em estantes e depois fica mais facil localizar.

[edison]

Opiniao pessoal:

Eu gosto de manual com espiral prendendo as paginas. Fica mais facil de se ler quando se estah tentando usar o equipamento, pois nao fecha sozinho e voce perde a pagina que estava lendo como com os manuais em brochura.

Outra opçao sao as folhas soltas para se prender em pastas, assim pode-se arquivar em estantes e depois fica mais facil localizar.

Concordo plenamente. Os grandes fabricantes disponibilizam manuais assim ( eles devem saber os benefícios) e o acrécimo no custo final é irrisório e facilmente pode (e deve) ser embutido no produto.
"E se tiveres renda...." o ideal é vc orçar com alguma gráfica a produção dele. Tem muito layoutista gráfico afim de um free-lance. Vc fornece o texto e imagens e ele faz toda a parte "artística" . Administrar desenvolvimento de projeto ,produção de manual, divulgação e parte comercial é "sóda", delegar as tarefas "menos nobres" é saudável e assim te sobra mais tempo prá parte técnica.

Té mais...

[Ander_sil]

Normalmente aqui na empresa fazemos tres manuais.

1 de operação do equipamente. (usuario).
2 de hardware (nele consta diagramas e as vezes troubleshooting para manutenção).
3 de software (api, comandos etc..)

Dependendo do equipamento as vezes tem alguma documentação a mais.

é isso.