ActiveDelphi - Índice do Fórum ActiveDelphi
.: O site do programador Delphi! :.
 
 FAQFAQ   PesquisarPesquisar   MembrosMembros   GruposGrupos   RegistrarRegistrar 
 PerfilPerfil   Entrar e ver Mensagens ParticularesEntrar e ver Mensagens Particulares   EntrarEntrar 

Documentação do sistema

 
Novo Tópico   Responder Mensagem    ActiveDelphi - Índice do Fórum -> Off-Topic
Exibir mensagem anterior :: Exibir próxima mensagem  
Autor Mensagem
joemil
Moderador
Moderador


Registrado: Quinta-Feira, 25 de Março de 2004
Mensagens: 9100
Localização: Sinop-MT

MensagemEnviada: Ter Dez 11, 2012 5:12 pm    Assunto: Documentação do sistema Responder com Citação

fala pessoal, tudo na paz?

estamos aqui na empresa com o pessoal da auditoria, e me pediram pra fazer a documentacao do sistema (eles irao ficar esta semana e voltaram no meio do ano q vem).

nao quero fazer a documentacao dos fontes, pois isso pode ser gerado pelo pasdoc ou algo parecido

preciso fazer um tipo de documentacao, so q nem sei quais os tipos.

vcs podem me ajudar com as algumas dicas? de como fazer? nao tenho ideia. poderia fazer um tipo de fluxograma, mas nao sei se seria o mais adequado.

vi o livro: Documentação para sistemas de gestao, Autor: Oliveira, Marco Antonio Lima de, Editora: Qualitymark, mas nao tem sinopse, nada (http://www.livrariasaraiva.com.br/produto/2530528/documentacao-para-sistemas-degestao/?PAC_ID=25371)

qq dica sera bem vinda.

valew
_________________
<b>SEMPRE COLOQUE [RESOLVIDO] NO SEU POST</b>
Enviar imagens: http://tinypic.com/
Voltar ao Topo
Ver o perfil de Usuários Enviar Mensagem Particular
maizena
Colaborador
Colaborador


Registrado: Terça-Feira, 20 de Março de 2012
Mensagens: 1497
Localização: Laguna - SC

MensagemEnviada: Qua Dez 12, 2012 7:28 am    Assunto: Responder com Citação

Relembrando a epoca da faculdade...rssss.....

Caro joemil, segundo informações de alguns amigos o pasdoc pega somente os comentários para fazer parte da documentação (não é uma informação confirmada), na minha opinião a documentação é a parte mais chata de se desenvolver um sistema porem imprescindível para o ciclo de vida de grandes sistemas.

Vc pode começar pelos diagramas.

Diagramas Estruturais
De Classe: Este diagrama é fundamental e o mais utilizado na UML e serve de apoio aos outros diagramas. O Diagrama de Classe mostra o conjunto de classes com seus atributos e métodos e os relacionamentos entre classes.

De Objeto: O diagrama de objeto esta relacionado com o diagrama de classes e, é praticamente um complemento dele. Fornece uma visão dos valores armazenados pelos objetos de um Diagrama de Classe em um determinado momento da execução do processo do software.

De Componentes: Está associado à linguagem de programação e tem por finalidade indicar os componentes do software e seus relacionamentos.
De implantação: Determina as necessidades de hardware e características físicas do Sistema.

De Pacotes: Representa os subsistemas englobados de forma a determinar partes que o compõem.

De Estrutura: Descreve a estrutura interna de um classificador.


Diagramas Comportamentais
De Caso de Uso (Use Case): Geral e informal para fases de levantamento e análise de Requisitos do Sistema.

De Máquina de Estados: Procura acompanhar as mudanças sofridas por um objeto dentro de um processo.

De Atividades: Descreve os passos a serem percorridos para a conclusão de uma atividade.

De Interação: Dividem-se em:

De Sequência: Descreve a ordem temporal em que as mensagens são trocadas entre os objetos.

Geral interação: Variação dos diagramas de atividades que fornece visão geral dentro do sistema ou processo do negócio.
De comunicação: Associado ao diagrama de Seqüência, complementando-o e concentrando-se em como os objetos estão vinculados.
De tempo: Descreve a mudança de estado ou condição de uma instância de uma classe ou seu papel durante o tempo.
Fonte: http://www.infoescola.com/engenharia-de-software/uml/

Estando criado os diagramas vc tera uma visão bem mais ampla do sistema ficando bem mais fácil a parte das descrições do sistema.

Segue um exemplo:
http://sites.usjt.br/tgi/DocProdutoSoftwareV3R-05.pdf
http://profpv.blogspot.com.br/2012/04/modelo-de-documentacao-de-software.html

Espero que ajude e boa sorte
_________________
Canal Delphi+ INSCREVA-SE: http://www.youtube.com/channel/UCnVF5ly5PRwZONE-U7xZM6w?feature=watch
Voltar ao Topo
Ver o perfil de Usuários Enviar Mensagem Particular MSN Messenger
joemil
Moderador
Moderador


Registrado: Quinta-Feira, 25 de Março de 2004
Mensagens: 9100
Localização: Sinop-MT

MensagemEnviada: Qua Dez 12, 2012 8:14 am    Assunto: Responder com Citação

puts. tudo isso? caraca véi.

acho q nao vou precisar de todos (ainda hehehe)

vou olhar e estudar cada um deles ate achar um q preciso (alias, nem sei o q preciso ainda kakaka)

de inicio preciso de algo tipo um fluxograma, pois irei precisar dar um treinamento inicial do sistema. pensei em algo tipo fluxograma (fiz algo no powerpoint pra apresentar a base do sistema - vejam a imagem):



vou fazer algo do tipo agora. depois irei precisar de algo mais "profissional" sobre as rotinas do sistema.

algum livro sobre o assunto?
_________________
<b>SEMPRE COLOQUE [RESOLVIDO] NO SEU POST</b>
Enviar imagens: http://tinypic.com/
Voltar ao Topo
Ver o perfil de Usuários Enviar Mensagem Particular
maizena
Colaborador
Colaborador


Registrado: Terça-Feira, 20 de Março de 2012
Mensagens: 1497
Localização: Laguna - SC

MensagemEnviada: Qua Dez 12, 2012 1:44 pm    Assunto: Responder com Citação

Para Fluxogramas e diagramas sempre utilizei o JUDE, na minha opinião um dos melhores, conheci ele na epoca da facul e ateh hoje utilizo ele.
Segue o link: http://jude.change-vision.com/jude-web/download/index.html

Espero que ajude.

Forte abraço
_________________
Canal Delphi+ INSCREVA-SE: http://www.youtube.com/channel/UCnVF5ly5PRwZONE-U7xZM6w?feature=watch
Voltar ao Topo
Ver o perfil de Usuários Enviar Mensagem Particular MSN Messenger
maizena
Colaborador
Colaborador


Registrado: Terça-Feira, 20 de Março de 2012
Mensagens: 1497
Localização: Laguna - SC

MensagemEnviada: Qua Dez 12, 2012 1:46 pm    Assunto: Responder com Citação

Ops esqueci de mencionar, da uma estudada em UML acho que este link pode te ajudar
http://docs.kde.org/stable/pt_BR/kdesdk/umbrello/uml-basics.html
Wink
_________________
Canal Delphi+ INSCREVA-SE: http://www.youtube.com/channel/UCnVF5ly5PRwZONE-U7xZM6w?feature=watch
Voltar ao Topo
Ver o perfil de Usuários Enviar Mensagem Particular MSN Messenger
wjuniordias
Profissional
Profissional


Registrado: Sexta-Feira, 16 de Março de 2012
Mensagens: 667

MensagemEnviada: Qui Fev 21, 2013 5:43 pm    Assunto: Responder com Citação

Tem uma ferramenta no Delphi que permite fazer modelagem, é a ferramenta Together. Fiz uma vídeo-aula introdutória sobre esse recurso, quem interessar:
http://www.youtube.com/watch?v=Ge4U6tfFFlQ&feature=youtu.be
_________________
"O sábio nunca diz tudo o que pensa, mas pensa sempre tudo o que diz." (Aristóteles)
Voltar ao Topo
Ver o perfil de Usuários Enviar Mensagem Particular Visitar a homepage do Usuário MSN Messenger
Mostrar os tópicos anteriores:   
Novo Tópico   Responder Mensagem    ActiveDelphi - Índice do Fórum -> Off-Topic Todos os horários são GMT - 3 Horas
Página 1 de 1

 
Ir para:  
Enviar Mensagens Novas: Proibido.
Responder Tópicos Proibido
Editar Mensagens: Proibido.
Excluir Mensagens: Proibido.
Votar em Enquetes: Proibido.


Powered by phpBB © 2001, 2005 phpBB Group
Traduzido por: Suporte phpBB