FRAMEWORK DE DOCUMENTAÇÃO QUID-IDE FRAMEWORK DE DOCUMENTAÇÃO Johnys Custódio da Silva Rabelo Leonardo Eustáquio Pessoa de Oliveira

Conjunto de Artefatos que auxiliam o projeto: 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. Leonardo

O que pode ser documentado? Aplicáveis: Documentação de Software. Não Aplicáveis: Monografia. Johnys

Quais as vantagens de uma boa documentação? Organização no processo de gerenciamento. Auxilia o levantamento de riscos. Visualização do escopo. Facilita manutenções futuras. Johnys

Como funciona o processo de documentação? Dividido em quatro etapas: Escolha do modelo Preenchimento do modelo Visualização do documento Impressão do documento Leo

Quais problemas surgem durante a 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. Johnys

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”. Leonardo

Quais as consequências? Necessidade de mais tempo. Aumento dos custos. Escolha entre escopo e tempo. Leonardo

Framework que facilite o processo de documentação. Soluçã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. Johnys

Impressão (exportação) Cenários do framework Modelagem. Preenchimento. Visualização. Impressão (exportação) Leonardo

2010 – Programação dos Artefatos Modelagem 2010 – Programação dos Artefatos 2011 – Divisão das responsabilidade do artefato em Serviços e Membros Johnys

2010 – idéia de formulário (rótulo e campo vazio) Preenchimento 2010 – idéia de formulário (rótulo e campo vazio) 2011 – apresentação no formato de visualização Leonardo

Visualizaçã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. Johnys

Impressão 2010 – acoplada ao artefato. 2011 – framework responsável pela leitura do artefato e sua exportação. Leonardo

Segmentação do documento Extensibilidade Qualidade da documentação Objetivos Flexibilidade Segmentação do documento Extensibilidade Qualidade da documentação Johnys

Divisão em três visões: Arquitetura Divisão em três visões: - Framework; - Plugins (Extensibilidade); - Aplicação. Leonardo

Fluxo 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.

Cadastrar usuários Perfis de usuário Manutenção dos grupos Gerente Preenchedor Montador Desenvolvedor. Manutenção dos grupos

Mapeamento dos TipoMembros O que é um TipoMembro? TipoMembro: Visão / Modelo O que é um Serviço? Mapeamento e versionamento.

Serviços Nativos Persistência Dependência Validação de dados

Montagem dos Artefatos Composição do Artefato. O que é um Membro? Vinculação de Membros e Serviços. Registro de Artefatos. Clonagem de Artefatos.

Montagem do Modelo Criação da TreeView. Registro de Modelos.

Criação do Documento Associação de um modelo a um grupo de usuários

Preenchimento do Documento Preenchimento dos Artefatos. Bloqueio de preenchimento simultâneo. Visualização dos Artefatos. Ordem de execução dos Serviços.

Impressão do Documento Exportação do Artefato Latex (Serviço)

Gerenciamento do framework Logs de operações

Mudanças recentes Grupo  Equipe Documento  Projeto Exportação  Publicação Forma de trabalho atual e divisão em dois projetos (Aplicação/Plugins + Framework)

Estado Atual 85% dos requisitos definidos 50% da arquitetura definida 0% dos casos de uso especificados 0% de implementação

Referências VALERIANO, 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).