Guia de Documentação de Software

De Wiki.bireme.org/pt
Ir para: navegação, pesquisa

Apoiar o usuário através de recomendações para a criação de documentos relativos a software e aplicativos em Wiki.

Escopo de documentos

Documentação de software divide-se em 3 categorias, conforme o público:

  • Manuais para usuário final;
  • Instruções de instalação e manutenção para administradores de sistemas e/ou de suporte,
  • Documentação técnica para desenvolvedores.

Para as duas primeiras categorias, recomendamos a criação de páginas Wiki. A documentação técnica para desenvolvedores deve ficar junto ao código fonte por questões práticas.

Recomendações gerais

Recomenda-se associar no nome do documento o nome e a versão do software sendo documentado.

ex.: Instalação do LILDBI-Web 1.7b

Recomenda-se também criar um documento com o mesmo nome, porém sem o nome e versão do software.

ex.: Instalação do LILDBI-Web

Naquela página coloca-se a instrução REDIRECT para a versão mais recente do documento conforme abaixo:

#REDIRECT [[Instalação do LILDBI-Web 1.7b]]

Conteúdo

Metodologias e tecnologias associadas podem ser apontadas como categorias do documento.

[[Categoria:LILACS]]
[[Categoria:ISIS]]

Forma

Sugere-se ler o documento Como criar artigos na Wiki para uma descrição de boas práticas de formatação e organização do documento.

Recomendações específicas