Quid-ide Framework de Documentação

Apresentação em tema: "Quid-ide Framework de Documentação"— Transcrição da apresentação:

1 Quid-ide Framework de Documentação
Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira

2 O que é documentação? Conjunto de elementos pré-definidos que se relacionam e se organizam em uma estrutura fixa; Repositório de informações; Comunicação entre os integrantes da equipe; Meio de validação do que é proposto com o que está sendo realmente desenvolvido.

3 O que pode ser documentado?
DMS – Documento de Modelagem de Software Manual Técnico O que não pode ser documentado? Monografia Artigo Científico

4 Vantagens de uma boa documentação
Organização no processo de gestão do projeto; Maior facilidade no controle do cronograma; Auxilia no levantamento de riscos; Facilidade nas manutenções futuras; Nivelamento da equipe em relação ao escopo do projeto desenvolvido;

5 Etapas do processo de documentação
Escolha do modelo (template); Preenchimento do modelo; Armazenamento dos documentos; Visualização dos documentos; Impressão dos documentos;

6 Problemas durante a documentação
Má interpretação do modelo por falta de informações; Não percepção das dependências entre os elementos do documento; Incompatibilidade entre os editores de texto; Dificuldade na integração dos documentos produzidos; Textos repetitivos.

7 Consequências da má documentação
Perda de tempo na organização da estrutura do documento; Retrabalho na documentação; Conteúdo mal elaborado; Aumento dos custos; Escolha entre escopo e tempo.

8 Solução Proposta Framework que facilite o processo de documentação;
Melhor controle da estrutura do documento; Manter o foco do usuário na criação do conteúdo;

9 Objetivos Flexibilidade Extensibilidade Segmentação de documentos
Qualidade na documentação

10 Definição das Entidades
Usuário Equipe Modelo Projeto Artefato Membro TipoMembro Serviço

11 Usuário Atores do sistema Perfis de Acesso: Administrador
Gerente de Projetos Desenvolvedor Montador Preenchedor

12 Equipe Conjunto de usuários que trabalham simultaneamente em um mesmo projeto.

13 Modelo e Projeto Modelo: Padronização de informações necessárias para o desenvolvimento de um projeto. Projeto: Todos os documentos criados por uma equipe a partir do modelo.

14 Artefato São elementos do modelo onde se armazena informações referentes a um mesmo assunto.

15 Membro São todas as partes que compõe um artefato, ou seja, todos os campos, desde o título até a legenda da tabela. Se caracterizam pelo seu posicionamento e tamanho no artefato.

16 TipoMembro São os componentes que permitem a montagem do artefato e o seu preenchimento Ao ser associado a um artefato, um TipoMembro passa ao conceito de Membro.

17 Serviço São todas as ações que ocorrem em cima de um artefato, ou seja, qualquer processamento de informações. Exemplos: Serviço de Persistência dos Dados; Serviço de Validação dos Dados; Serviço de Dependência entre Artefatos;

18 Fases do Framework Desenvolvimento de componentes;
Montagem de artefatos; Montagem do modelo; Definição de usuários e equipes; Criação do projeto; Preenchimento e Armazenamento do projeto; Publicação do projeto;

19 Arquitetura Camadas Lógicas

20 Diagrama Geral de Sequência
Arquitetura Diagrama Geral de Sequência

21 Tecnologias Utilizadas
Java v1.6 Apache Tomcat v7.x JavaServer Faces v2.0 Primefaces v2.x JPA v2.x Hibernate v3.x Spring Framework v2.x SGBD Postgres v9.x

22 Conclusão