Documentação do produto de software

O software ideal seria livre de erros e tão fácil de usar que todo mundo ia estar familiarizado com ele no momento em que iniciar a aplicação. No entanto, este não é o caso na realidade.

Além da qualidade do produto de software, há outra coisa que faz ou quebra o negócio: suporte técnico. O melhor que os editores e autores de suporte de software shareware fornecer, os usuários estão mais propensos a comprar o produto.

O suporte técnico para produtos de software pode ser fornecida em várias formas:
documentação do produto online
e-mail assistência
acesso a suporte fóruns mantidos por editores de software
bases de conhecimento.


Boa documentação pode excluir, em muitos casos a necessidade de outras formas de apoio técnico. É, no entanto, não é fácil de escrever. Uma das razões por que isso acontece é que é difícil para os autores de shareware ou desenvolvedores de software para se colocar nos sapatos dos usuários, uma vez que eles já estão bem familiarizados com a aplicação.

Arquivo Leia-me

A primeira coisa que cada produto de software deve ter é um formato de texto "Leia-me" arquivo que inclui o seguinte:
Nome do produto e Versão
Navio data
Empresa e Nome do Autor
Descrição (como "organizador de fotos")
A lista que há de novo (esta deve ser uma lista de correções e novos recursos)
Requisitos do sistema (hardware, como CPU, memória RAM, espaço em disco, os sistemas operacionais suportados)
Opções de preço, pagamento e instruções
Direitos autorais e distribuição de informação (regras para as pessoas que querem distribuir o seu produto)
Detalhes de contato (e-mail, telefone, site, fax e endereço postal)


O "Leia-me" do arquivo é importante, porque todo mundo que poderia estar interessado no seu produto está esperando, incluindo revisores, usuários ou pessoas que querem colocar seu produto em um CD para distribuição com uma revista ou em seu site. A idéia aqui é para minimizar a frustração associada com a informação que está sendo muito difícil de encontrar, por isso você deve colocar tudo em um só lugar.

O Manual

A outra coisa que os autores de shareware e editores de software terá de dar o seu produto é o manual. A primeira coisa que você deve pensar quando começar a escrever é como os usuários estão indo para usá-lo. Poucos são aqueles que vão se preocupar ler tudo antes de tentar usar o seu produto. Eles são mais propensos a recorrer a ele mais tarde, quando eles tentam fazer algo e não consegue descobrir como fazê-lo, ou quando encontram algo que eles não entendem.

Para ajudá-los, o melhor é organizar a documentação por tarefas. "Como ..." seções são mais úteis do que meramente documentando cada comando em ordem. Explicações são mais fáceis de entender se eles são apoiados por fotos e diagramas, sempre que possível. Também deve haver um capítulo denominado "Resolução de Problemas", que fornece respostas para os problemas mais comuns. Na primeira você terá que adivinhar onde os problemas podem ocorrer, mas um par de upgrades para o seu produto mais tarde, o feedback das pessoas que experimentaram o produto irá dizer-lhe quais são os problemas mais comuns são.
O manual deve ser dividido em capítulos, o primeiro dos quais dizendo que os restantes capítulos, de modo que as pessoas podem facilmente encontrar o que precisam.

A interface

Outro ponto que merece mentionning é a interface. Amigável, não é suficiente, a interface precisa ser navigatable mesmo se o usuário não tiver um entendimento geral de sistemas, de modo que as telas precisa ser auto-descreve.

Ajuda online ou documentação on-line

Há também ajuda on-line, ou documentação online. A documentação colocar no site para que os usuários leiam tem que aparecer nos resultados de busca. Ele tem de ser organizada de tal forma que os usuários, que são a certeza de estar fazendo perguntas como "Como pode Eu. .." ou "Por que não eu .." pode encontrar as respostas rapidamente. Muitos exemplos que mostram como fazer várias tarefas com o produto de software também são necessários. Uma boa idéia é incluir links para um glossário de termos que podem ser mais difíceis de entender.

Tenha sempre em mente que qualquer pessoa que tenha tido uma má experiência com um produto tende a se lembrar por muito tempo e software não é diferente. É por isso que você deve se esforçar para fazer usando o seu produto como uma experiência mais suave possível, apoio algo próprio e documentação pode ajudar a conseguir....