| Autor |
Mensagem |
![[Post New]](/templates/default/images/icon_minipost_new.gif) 12/06/2007 13:22:57
|
Ticianne
JavaGuru
![[Avatar]](/images/avatar/67ad4113ae200c56e74d7177b37d9469.jpg)
Membro desde: 16/05/2006 15:48:51
Mensagens: 249
Localização: Fortaleza-Ce
Offline
|
Boa tarde carissimos amigos
estou fazendo uma pesquisa: preciso saber quais os principais documentos geralmetente utilizados para a documentação de um sistema ou software.
achei um artigo muito bom dia desses mas perdi ... 
enfim
sei que eh imprescindivel a modelagem UML, a análise de requisitos, o projeto básico com cronograma essas coisas. Além desses, que outros documentos costumam ser incluidos?
Ah, sabendo de mais documentos, o colega pode deixar um pequeno exemplo de como ele seria?
gratissima 
|
"Nao se enganem, Deus nao se deixa escarnecer, aquilo que o homem semear,isso também ceifará."
Gl 6:7
--------------------------------------------------------
 
-------------------------------------------------------- |
|
|
 |
|
|
12/06/2007 14:01:37
|
eric_jf
JavaEvangelist
Membro desde: 07/07/2006 12:28:12
Mensagens: 393
Offline
|
O documento mais importante é o codigo fonte, como diria Martin Fowler:
?Qualquer tolo consegue escrever código que um computador entenda. Bons programadores escrevem código que humanos possam entender.?
|
|
|
|
12/06/2007 14:24:56
|
peczenyj
Moderador
![[Avatar]](/images/avatar/299dc35e747eb77177d9cea10a802da2.jpg)
Membro desde: 26/03/2006 23:25:37
Mensagens: 3191
Localização: Rio de Janeiro
Offline
|
Os documentos dependem muito do processo e da métodologia.
Vc pode colocar muita informação em um comentário no início de cada código, por exemplo, e isso não é algo 'ruim', pelo contrario, pode ser ágil.
|
http://pacman.blog.br
'Não importa quanto alguém se dedique à tarefa. Ninguém consegue fazer a água da cascata cair para cima.' |
|
|
|
12/06/2007 14:35:04
|
Ticianne
JavaGuru
Membro desde: 16/05/2006 15:48:51
Mensagens: 249
Localização: Fortaleza-Ce
Offline
|
Eu sei...
quanto aos comentários, ja estao padronizados quanto a forma a aparecer no codigo e todo metodo e classe tera comentarios em locais especificos.
tambem vou gerar um documento tipo javadoc utilizando Doxygen, que vai deixar o entendimento da codificação bem feito.
Mas o que quero saber eh quanto à documentação formal. Documentos que devem ser apresentados quando da entrega do projeto ao cliente.
Por isso citei uml, requisitos etc.
o que pergunto eh:
Nesse caso, quais são minhas opções para documentação que, nesse sentido citado, represente o sistema e o desenvolvimento?
|
"Nao se enganem, Deus nao se deixa escarnecer, aquilo que o homem semear,isso também ceifará."
Gl 6:7
--------------------------------------------------------
-------------------------------------------------------- |
|
|
|
12/06/2007 14:53:42
|
Luca
Moderador
![[Avatar]](/images/avatar/17e62166fc8586dfa4d1bc0e1742c08b.jpg)
Membro desde: 06/09/2002 14:30:10
Mensagens: 5810
Localização: São Paulo/SP ou Paraty/RJ
Offline
|
Olá
Procure ler sobre XP e veja quais documentos são usados. Leia o blog da improveit e do sanchez.
Exemplos:
http://www.agilemodeling.com/essays/agileModelingXP.htm
http://www.xprogramming.com/xpmag/FussAboutDocumentation.htm
http://www.agilemodeling.com/essays/agileDocumentation.htm
Acho que você deve entregar:
- Para que serve o projeto em linhas gerais
- Os problemas resolvidos, lista das facilidades (features)
- O resumo dos testes funcionais e unitários
- Javadoc, se for uma API para ser usada por outros
- As modelagens das principais classes de negócio
- As modelagens da base de dados
- Manual do usuário
- Histórico dos contatos com o cliente (emails, reuniões, msn, etc.)
- Mais qualquer blá, blá, blá enfeitado que seu departamento de marketing ache útil para conseguir novos serviços com este cliente.
O documento mais importante para entregar ao cliente é a fatura 
[]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/ |
|
|
|
12/06/2007 14:59:59
|
Ticianne
JavaGuru
Membro desde: 16/05/2006 15:48:51
Mensagens: 249
Localização: Fortaleza-Ce
Offline
|
boa.
a fatura, claro! como poderia ser tao tola?!
valeu luca, vou dar uma olhadinha!
mais sugestões são bem vindas!
|
"Nao se enganem, Deus nao se deixa escarnecer, aquilo que o homem semear,isso também ceifará."
Gl 6:7
--------------------------------------------------------
-------------------------------------------------------- |
|
|
|
12/06/2007 16:53:28
|
J2Alex
JavaEvangelist
![[Avatar]](/images/avatar/f4be00279ee2e0a53eafdaa94a151e2c.png)
Membro desde: 18/01/2003 08:14:41
Mensagens: 348
Localização: São José dos Campos
Offline
|
faça essa pergunta para o cv...
|
Alexandre
Hoje tem Balada
https://apps.facebook.com/hojetembalada
Guia colaborativo de baladas, bares e restaurantes |
|
|
|
|
|
![[Up]](/templates/default/images/icon_up.gif){kind=icon}
![[WWW]](/templates/default/images/icon_www.gif){kind=icon}
![[Email]](/templates/default/images/icon_email.gif){kind=icon}