QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de...
Transcript of QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de...
![Page 1: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/1.jpg)
QUID-IDEQUID-IDE
FRAMEWORK DE DOCUMENTAÇÃO
Johnys Custódio da Silva RabeloLeonardo Eustáquio Pessoa de Oliveira
![Page 2: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/2.jpg)
O que é documentação?O que é documentação?
Conjunto de Artefatos que auxiliam o projeto:◦comunicação durante seu
desenvolvimento;◦repositório de informações;◦melhor entendimento das atividades.
![Page 3: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/3.jpg)
O que pode ser documentado?O que pode ser documentado?
Aplicáveis: Documentação de Software.
Não Aplicáveis: Monografia.
![Page 4: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/4.jpg)
Quais as vantagens de uma boa Quais as vantagens de uma boa documentação?documentação?
Organização no processo de gerenciamento.
Auxilia o levantamento de riscos.Visualização do escopo.Facilita manutenções futuras.
![Page 5: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/5.jpg)
Como funciona o processo de Como funciona o processo de documentação?documentação?
Dividido em quatro etapas:◦Escolha do modelo◦Preenchimento do modelo◦Visualização do documento◦Impressão do documento
![Page 6: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/6.jpg)
Quais problemas surgem durante a Quais problemas surgem durante a documentação?documentação?
Má interpretação do modelo.Má percepção das dependências.Textos repetitivos.Incompatibilidade entre os
editores de texto.Dificuldade de integração dos
artefatos produzidos.
![Page 7: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/7.jpg)
Quais as consequências?Quais as consequências?
Foco do preenchedor na estrutura e organização do documento .
Retrabalho na documentação.Conteúdo mal elaborado.Visão obsoleta: “documentação é
atraso para o projeto”.
![Page 8: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/8.jpg)
Quais as consequências?Quais as consequências?
Necessidade de mais tempo.
Aumento dos custos.
Escolha entre escopo e tempo.
![Page 9: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/9.jpg)
Solução PropostaSolução Proposta
Framework que facilite o processo de documentação.
Controla a estrutura do documento.
Manter o foto do usuário no conteúdo do documento.
![Page 10: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/10.jpg)
Cenários do frameworkCenários do framework
Modelagem.
Preenchimento.
Visualização.
Impressão (exportação)
![Page 11: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/11.jpg)
ModelagemModelagem
2010 – Programação dos Artefatos
2011 – Divisão das responsabilidade do artefato em Serviços e Membros
![Page 12: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/12.jpg)
PreenchimentoPreenchimento
2010 – idéia de formulário (rótulo e campo vazio)
2011 – apresentação no formato de visualização
![Page 13: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/13.jpg)
VisualizaçãoVisualização
2010 – Os artefatos eram responsáveis por gerar a interface de visualização.
2011 – O descritor de tela coletará informações dos artefatos para exibí-los.
![Page 14: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/14.jpg)
ImpressãoImpressão
2010 – acoplada ao artefato.
2011 – framework responsável pela leitura do artefato e sua exportação.
![Page 15: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/15.jpg)
ObjetivosObjetivos
Flexibilidade
Segmentação do documento
Extensibilidade
Qualidade da documentação
![Page 16: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/16.jpg)
ArquiteturaArquitetura
Divisão em três visões:◦- Framework;◦- Plugins (Extensibilidade);◦- Aplicação.
![Page 17: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/17.jpg)
Fluxo de trabalho do projetoFluxo de trabalho do projeto
Cadastrar usuários.Mapeamento dos TipoMembros e
Serviços para framework.Montagem dos Artefatos.Montagem do Modelo.Criação do Documento.Preenchimento do Documento.Impressão do Documento.Gerenciamento do framework.
![Page 18: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/18.jpg)
Cadastrar usuáriosCadastrar usuários
Perfis de usuário◦Gerente◦Preenchedor◦Montador◦Desenvolvedor.
Manutenção dos grupos
![Page 19: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/19.jpg)
Mapeamento dos Mapeamento dos TipoMembrosTipoMembros
O que é um TipoMembro?
TipoMembro: Visão / Modelo
O que é um Serviço?
Mapeamento e versionamento.
![Page 20: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/20.jpg)
Serviços NativosServiços Nativos
Persistência
Dependência
Validação de dados
![Page 21: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/21.jpg)
Montagem dos Montagem dos ArtefatosArtefatos
Composição do Artefato.
O que é um Membro?
Vinculação de Membros e Serviços.
Registro de Artefatos.
Clonagem de Artefatos.
![Page 22: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/22.jpg)
Montagem do Montagem do ModeloModelo
Criação da TreeView.
Registro de Modelos.
![Page 23: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/23.jpg)
Criação do Criação do DocumentoDocumento
Associação de um modelo a um grupo de usuários
![Page 24: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/24.jpg)
Preenchimento do Preenchimento do DocumentoDocumento
Preenchimento dos Artefatos.Bloqueio de preenchimento
simultâneo.Visualização dos Artefatos.Ordem de execução dos
Serviços.
![Page 25: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/25.jpg)
Impressão do Impressão do DocumentoDocumento
Exportação do Artefato
Latex (Serviço)
![Page 26: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/26.jpg)
Gerenciamento do frameworkGerenciamento do framework
Logs de operações
![Page 27: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/27.jpg)
Mudanças recentesMudanças recentes
Grupo EquipeDocumento ProjetoExportação Publicação
Forma de trabalho atual e divisão em dois projetos (Aplicação/Plugins + Framework)
![Page 28: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/28.jpg)
Estado AtualEstado Atual
85% dos requisitos definidos
50% da arquitetura definida
0% dos casos de uso especificados
0% de implementação
![Page 29: QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira.](https://reader036.fdocumentos.com/reader036/viewer/2022062700/552fc118497959413d8c8eae/html5/thumbnails/29.jpg)
ReferênciasReferênciasVALERIANO, D.L. Gerência em
Projetos: pesquisa, desenvolvimento e engenharia. São Paulo, 1998. Markron Books, 1998.
Santos, Jonathan Bruno Silva. FrameWork de documentação. [Anápolis] 2010.(UEG / UnUCET, Bacharelado em Sistemas de Informação, 2010).