Como montar documentação de um programa?

Question

Quando se desenvolve um programa a documenta&ccedil;&atilde;o &eacute; uma parte chata, mas, necess&aacute;ria, quero saber onde encontro defini&ccedil;&otilde;es e recomenda&ccedil;&otilde;es sobre a cria&ccedil;&atilde;o desse tipo de doc.

E, aproveitando, quero tirar umas d&uacute;vidas, o que &eacute; changelog?

Como montar um ?

Sempre devo fazer um Readme??

Existe algum padr&atilde;o, tipo ISO, WC3 para cria&ccedil;&atilde;o dessas coisas??

Tem uma listinha de itens mais usados na documenta&ccedil;&atilde;o??

abra&ccedil;o,
valeu.

Answer

Humm... Como documentar um programa? &eacute; uma quest&atilde;o meio gen&eacute;rica demais.
Documentar o c&oacute;digo fonte do programa? Ou documentar os componentes do sistema, de forma relativamente independente da linguagem de programa&ccedil;&atilde;o? Ou documentar as regras de neg&oacute;cio? Ou tudo isso e mais um pouco?

Answer

[quote=jackinabox]Humm... Como documentar um programa? &eacute; uma quest&atilde;o meio gen&eacute;rica demais.
Documentar o c&oacute;digo fonte do programa? Ou...[/quote]

 :oops: ...foi malz ...

bem, acho que esses: 

--> Documentar o c&oacute;digo fonte do programa? 

--> Documentar os componentes do sistema, de forma relativamente independente da linguagem de programa&ccedil;&atilde;o?

obrigado! ;-)

Answer

Veja se isso n&atilde;o te ajuda:

http://www.stack.nl/~dimitri/doxygen/

Answer

tem o dia   :roll:  ..para fazer esquemas &eacute; legalzinho 
http://www.gnome.org/projects/dia/ 
P.S:Tem para windows tb

Answer

depende da linguagem de programa&ccedil;&atilde;o e qual o objectivo da documenta&ccedil;&atilde;o.

para as minhas bibliotecas de C uso o doxygen, para Java o IDE que uso faz isso automaticamente e em Haskell temos o haddock.

para trabalhos da Universidade (feitos em Haskell) como o objectivo n&atilde;o &eacute; obter a API mas sim explicar o trabalho uso o lhs2TeX, que me permite a partir do mesmo ficheiro obter um documento escrito (em LaTeX) com c&oacute;digo fonte pelo meio e criar um programa exec&uacute;tavel.

Answer

valeu gente, j&aacute; deu pra entender o que eu queria.

t+

Ferramentas

Mover Tópico