Documentação de projetos de sistema

Documentos do Word são estáticos, wikis são dinâmicos, um é fácil de usar e muito usado, outro é difícil de configurar e instalar.

Documentações de sistemas que seguem algum processo são baseadas em diversos documentos: plano de empreendimento, atas de reunião, padrão de banco de dados, arquitetura, design, infra-estrutura, segurança, registros de riscos, modelos e especificações de casos de uso, cenários e relatórios de validação de arquitetura, implementação, testes, planos de ambientes, protótipos de interfaces, requisições de mudança, etc.

A utilização de documentos Word para criar essa documentação tem dois problemas estruturais:

  1. não existe uma forma trivial de criar e utilizar templates de documentos Word e muito menos reaproveitar documentos criados a partir de um template. Quando um novo projeto vai ter o conteúdo muito semelhante a outro projeto já realizado, é mais simples duplicar o documento final do projeto já realizado e fazer as alterações do que criar um novo documento a partir do template vazio e copiar trechos de texto de um documento para outro, perdendo-se assim qualquer melhoria que tenha sido realizada no template
  2. ao final do processo temos uma documentação segmentada em inúmeros arquivos, hierarquizados em pastas, interligados apenas por referência textual de um documento a outro

Para organizar esses incontáveis arquivos Word armazenados em pastas, toda documentação deveria ser feita em wiki, abusando de hyperlinks, mas para isso precisaríamos de uma plataforma wiki extremamente simples, com controle de versão transparente e excelente usabilidade.

A possibilidade de utilizar formulários para a entrada de informações no wiki a partir de templates dos documentos, além de poder “herdar” outros documentos já produzidos torna a abordagem wiki para documentação extremamente atraente.

Ganharíamos com isso velocidade na criação de novos projetos, melhor navegação entre as interdependências dos diversos documentos e o que é melhor, documentação padronizada e facilmente acessível.

Deixe um Comentário

1 Comentários.

  1. Gostei da abordagem. Você pode informar algumas iniciativas do uso do wiki para documentação de projetos?

Não fique de fora, dê sua opinião!

%d blogueiros gostam disto: