Documentos utilizados na documentação de sistema ?!

6 respostas
Ticianne

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 … :frowning:

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?

:stuck_out_tongue:

gratissima :smiley:

6 Respostas

eric_jf

O documento mais importante é o codigo fonte, como diria Martin Fowler:

peczenyj

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.

Ticianne

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?

Luca

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 :lol:

[]s
Luca

Ticianne

boa.

a fatura, claro! como poderia ser tao tola?! :stuck_out_tongue:

valeu luca, vou dar uma olhadinha!

mais sugestões são bem vindas!

J2Alex

faça essa pergunta para o cv… :lol:

Criado 12 de junho de 2007
Ultima resposta 12 de jun. de 2007
Respostas 6
Participantes 5