Melhores práticas para documentação e projeto de sistemas

JavaEvangelist Membro desde: 02/05/2006 15:30:50 Mensagens: 475 Offline

Olá pessoal.

Estou abrindo este tópico para discutir sobre quais são as práticas e métodos estamos utilizando para projetar e documentar um sistema.

Sabemos que a documentação é uma parte essencial no desenvolvimento de sistemas, facilitando o entendimento entre as equipes do projeto e também para futuras modificações e novos membros na equipe.

Gostaria de saber de vocês o que vocês tem utilizado para documentar e projetar sistemas, qual métodologia estão seguindo.

Abraços

JavaDoc, nada mais pratico e simples.

Sem falar em metodos legiveis, que dispensam documentacao

JavaEvangelist Membro desde: 28/12/2008 21:00:08 Mensagens: 349 Offline

Javadoc e pelo menos um diagrama de classe, pois ajuda muito na hora de visualizar o modelo sem apelar para o código (pelo menos um diagrama contendo a modelagem de uma parte complexa do sistema).

This message was edited 1 time. Last update was at 30/04/2010 08:31:25

Javadoc e pelo menos um diagrama de classe, pois ajuda muito na hora de visualizar o modelo sem apelar para o código (pelo menos um diagrama contendo a modelagem de uma parte complexa do sistema).

Nas minhas documentações, utilizo o JavaDoc e também alguns diagramas para as partes complexas do sistemas.

Eu ja gosto da idéia da metodologia agíl, apesar de não seguir alguma em especifico. Uma coisa que gosto de fazer e que quando estou desenvolvendo o código, dependendo do nível de complexidade ir fazendo em paralelo um diagrama em UML. E também uma das coisas importantes o teste do sistema.

Notícias, artigos e o maior fórum brasileiro sobre Java