none
Documentação de Projeto, como fazer

    Question

  •  

     

    Pessoal,

    Iniciei um projeto web para a Intranet da empresa, inclusos os intens abaixo:

    • CSS;
    • Javascript;
    • Bancos de dados;
    • Funções ASP;
    • HTML;
    • e Páginas ASP.

     

    Foi-me solicitado, agora, criar a documentação deste projeto.

     

    Alguem sabe por onde eu começo, ou possui o passo a passo(checklist) de como fazer?

    Como listar todas funções ASP?

    Como listar todas funções Javascript?

    Devo listar todas as variáveis?

     

    Abraços,

     

    Marcelo Cavalini

    Monday, October 08, 2007 7:46 PM

Answers

  • Boa tarde.

     

    Marcelo.

     

    Se eu pegasse teu projeto, iria gostar mais de ver documentado as regras de negócio do que onde estão as funções e etc. (não que não ajude)

     

    Minha opinião é de que você deve:

    1º - Documente o sistema, suas logicas, o que cada página faz

    2º - Documente a estrutura do site colocando as páginas, quem linka com quem, css, .js, etc.

    3º - Faça uma documentação de procedures, funções e view (do banco de dados) caso você esteja utilizando esses recursos.

     

    OBS: Não acho que compensa você criar uma documentação de todas as funcionalidades que possuem seu projeto e o que cada uma faz. Deixe isso para um comentário mais técnico, aquele que nós deixamos no próprio código fonte do projeto (espero que tenha feito *rs*).

     

    Bom. Acho que se eu tivesse isso em mãos, com certeza veria seu trabalho com bons olhos... mas lembre-se... não é nada fácil fazer essa engenharia reversa.

     

    Abraço

    Espero ter clareado sua idéia

    Think Ahead

     

    Monday, October 08, 2007 7:55 PM
  • Boa Tarde , tenho que fazer a documentação da extranet da minha empresa, não sei por onde começar.
    Existe alguma ferramenta que me ajude a fazer isso? Tem algum link onde posso ver mais sobre esse procedimento?

    Obrigado

    Andreassa.Si

    Bom dia Andreassa.SI.

    Eu utilizo em meus projetos a ferramenta Visual Paradigm Project  e acho ela muito boa, a versão community é free e possui muitos recursos. 

    Thursday, March 14, 2013 11:58 AM
  • Documentação é muito relativo, qual modelo de dev vc usa(scrum,kanbam,rup) hj o que eu acho muito importante é vc ter seu código bem documentado.

    acho que as métodologias agéis melhores de trabalhar


    Não esqueça de usar o componente </> na barra para posta seu código. Microsoft MCPD,MCTS,MCC

    Friday, March 15, 2013 11:16 AM

All replies

  • Boa tarde.

     

    Marcelo.

     

    Se eu pegasse teu projeto, iria gostar mais de ver documentado as regras de negócio do que onde estão as funções e etc. (não que não ajude)

     

    Minha opinião é de que você deve:

    1º - Documente o sistema, suas logicas, o que cada página faz

    2º - Documente a estrutura do site colocando as páginas, quem linka com quem, css, .js, etc.

    3º - Faça uma documentação de procedures, funções e view (do banco de dados) caso você esteja utilizando esses recursos.

     

    OBS: Não acho que compensa você criar uma documentação de todas as funcionalidades que possuem seu projeto e o que cada uma faz. Deixe isso para um comentário mais técnico, aquele que nós deixamos no próprio código fonte do projeto (espero que tenha feito *rs*).

     

    Bom. Acho que se eu tivesse isso em mãos, com certeza veria seu trabalho com bons olhos... mas lembre-se... não é nada fácil fazer essa engenharia reversa.

     

    Abraço

    Espero ter clareado sua idéia

    Think Ahead

     

    Monday, October 08, 2007 7:55 PM
  •  

    Obrigado Daniel, já é um começo!
    Monday, October 08, 2007 8:02 PM
  •  Daniel Lourenço Curado wrote:

    Se eu pegasse teu projeto, iria gostar mais de ver documentado as regras de negócio do que onde estão as funções e etc. (não que não ajude)

     

    Minha opinião é de que você deve:

    1º - Documente o sistema, suas logicas, o que cada página faz  OK

    2º - Documente a estrutura do site colocando as páginas, quem linka com quem, css, .js, etc.  OK

    3º - Faça uma documentação de procedures, funções e view (do banco de dados) caso você esteja utilizando esses recursos.

     

     

    Daniel, o que você quer dizer com regras de negócios?

     

    Como fazer a documentação das procedures, funções e views do banco de dados??

     

     

    Abraços,

    Wednesday, October 10, 2007 7:05 PM
  • Olá Marcelo,

     

    Regra de Negócio é a maneira como funciona um determinado negócio, é como o sistema deve tratar algum evento. Não confunda regra de negócio com o que o Sistema deve fazer, chamamos isso de Requisitos de Sistema.

    Geralmente quem define a regra de negócio é o cliente, pois ele é que conhece o seu negócio e sabe exatamente como o mesmo funciona.

     

    Por exemplo: Ao inserir um novo cliente em minha base de dados, o mesmo fica com status pendente para a confirmação dos seus dados e referâncias comercias, somente após essa confirmação será liberado crédito.

     

    O exemplo acima pode ser entendido como uma regra de negócio de um sistema qualquer.

     

    Como o nosso colega falou acima, engenharia reversa não é muito simples de fazer. Porém, se você mesmo fez a análise e o desenvolvimento do sistema não será muito complicado.

     

    Espero ter ajudado.

     

    Um abraço.

    Tuesday, October 16, 2007 10:53 AM
  • Boa Tarde , tenho que fazer a documentação da extranet da minha empresa, não sei por onde começar.
    Existe alguma ferramenta que me ajude a fazer isso? Tem algum link onde posso ver mais sobre esse procedimento?

    Obrigado

    Andreassa.Si
    Tuesday, November 11, 2008 7:40 PM
  • Boa Tarde , tenho que fazer a documentação da extranet da minha empresa, não sei por onde começar.
    Existe alguma ferramenta que me ajude a fazer isso? Tem algum link onde posso ver mais sobre esse procedimento?

    Obrigado

    Andreassa.Si

    Bom dia Andreassa.SI.

    Eu utilizo em meus projetos a ferramenta Visual Paradigm Project  e acho ela muito boa, a versão community é free e possui muitos recursos. 

    Thursday, March 14, 2013 11:58 AM
  • Documentação é muito relativo, qual modelo de dev vc usa(scrum,kanbam,rup) hj o que eu acho muito importante é vc ter seu código bem documentado.

    acho que as métodologias agéis melhores de trabalhar


    Não esqueça de usar o componente </> na barra para posta seu código. Microsoft MCPD,MCTS,MCC

    Friday, March 15, 2013 11:16 AM