Documentacao de Software  XML
Índice dos Fóruns » Assuntos gerais (Off-topic)
Autor Mensagem
[Post New]19/05/2010 11:26:14
    Assunto: Documentacao de Software
[Up]
paulofernandesjr
JavaEvangelist
[Avatar]
Membro desde: 04/10/2007 12:36:58
Mensagens: 474
Localização: São Paulo - Capital
Offline
Bom dia

Recebi uma solicitação para documentar um software, o software está pronto e algumas partes funcionando, porém não fui eu quem o fez.

Alguem poderia me ajudar com dicas de por onde começar?

Obrigado
Paulo Fernandes
Desenvolvedor Java

Aprenda CSS
Twitter
[Email] [WWW] [MSN]
[Post New]19/05/2010 11:34:47
    Assunto: Re:Documentacao de Software
[Up]
FrancoC
JavaTeenager
[Avatar]

Membro desde: 15/10/2009 13:11:25
Mensagens: 193
Offline
Documentar um software é um conceito muito vago. Você está se referindo a uma documentação para o usuário final, mais especificamente um manual, ou documentos de visão, casos de uso, DER, UML cobrindo a arquitetura do software e outros artefatos gerados durante um Processo Unificado ou ainda JavaDocs sobre a codificação

This message was edited 2 times. Last update was at 19/05/2010 11:38:05
Get the facts first. You can distort them later.
[Post New]19/05/2010 11:36:06
    Assunto: Re:Documentacao de Software
[Up]
Luca
Moderador
[Avatar]

Membro desde: 06/09/2002 14:30:10
Mensagens: 5810
Localização: São Paulo/SP ou Paraty/RJ
Offline
Olá

O mais rápido é colocar o projeto no maven que já ganha de quebra um site. Dái é só criar descrições resumidas do que já foi feito e guardar no site.

Uma ferramenta importante é criar um wiki.

Uma outra alternativa de site para documentos de projetos é o Apache Forrest que usei há 5 anos atrás e nem sei se ainda existe.

[]s
Luca
Dare Obasanjo (Program Manager at Microsoft)
"The folks I know from across the industry who have to build large scale Web services on the Web today at Google, Yahoo!, Facebook, Windows Live, Amazon, etc are using RESTful Web services. The only times I encounter someone with good things to say about WS-* is if it is their job to pimp these technologies or they have already "invested" in WS-* and want to defend that investment."


CEP, JMS, JMX e coisas afins (ou não)
http://lucabastos.blogspot.com/
[Email] [WWW]
 
Índice dos Fóruns » Assuntos gerais (Off-topic)
Ir para:   
Powered by JForum 2.1.8 © JForum Team