Documentação de Software

[Matthaus 0]

Olá a todos,

Gostaria de tirar uma dúvida, e não teria lugar melhor que aqui no fórum...espero não estar incomodando :)

 

Minha dúvida diz respeito a como formatar uma documentação de um software...gostaria de estar listando as funções e classes de um framework, e também seus módulos...conheço UML mais acredito num ser suficiente para documentar tudo...ou estou falando algo errado? http://forum.imasters.com.br/public/style_emoticons/default/ermm.gif

Neste caso devo utilizar as regras da ABNT ou teria algo mais a fundo que rege esse mundo da documentação de software?... :rolleyes:

 

Bom, agradeço a todos que leram e as possíveis respostas

 

Abraço!

[san software 0]

Boa noite Matthaus.

Eu lhe aconselharia:

1- a fazer uma leitura sobre PADRÕES DE PROJETOS DE SOFTWARES, pois você não cito se seu projeto é um WebService ou Desktop, mas poderá iniciar pela leitura do padrões;

2- escolher o padrão que mais lhe parece ideal ao seu projeto;

3- tente documentar todo o sistema ou boa parte, pois se seu sistema for grande irá lhe poupar muito trabalho no futuro;

4- UML não é tudo, tem CASOS DE USO, IHM...e varios outros documentos necessários os quais você irá encontrar se fizer a leitura no indíce 1 acima.

 

No início dá trabalho, mas com o tempo irá lhe poupar trabalho essa documentação.

http://forum.imasters.com.br/public/style_emoticons/default/thumbsup.gif http://forum.imasters.com.br/public/style_emoticons/default/thumbsup.gif http://forum.imasters.com.br/public/style_emoticons/default/thumbsup.gif http://forum.imasters.com.br/public/style_emoticons/default/thumbsup.gif