QUID-IDEQUID-IDE

FRAMEWORK DE DOCUMENTAÇÃO

Johnys Custódio da Silva RabeloLeonardo Eustáquio Pessoa de Oliveira

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.

O que pode ser documentado?O que pode ser documentado?

Aplicáveis: Documentação de Software.

Não Aplicáveis: Monografia.

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.

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

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.

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

Quais as consequências?Quais as consequências?

Necessidade de mais tempo.

Aumento dos custos.

Escolha entre escopo e tempo.

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.

Cenários do frameworkCenários do framework

Modelagem.

Preenchimento.

Visualização.

Impressão (exportação)

ModelagemModelagem

2010 – Programação dos Artefatos

2011 – Divisão das responsabilidade do artefato em Serviços e Membros

PreenchimentoPreenchimento

2010 – idéia de formulário (rótulo e campo vazio)

2011 – apresentação no formato de visualização

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.

ImpressãoImpressão

2010 – acoplada ao artefato.

2011 – framework responsável pela leitura do artefato e sua exportação.

ObjetivosObjetivos

Flexibilidade

Segmentação do documento

Extensibilidade

Qualidade da documentação

ArquiteturaArquitetura

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

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.

Cadastrar usuáriosCadastrar usuários

Perfis de usuário◦Gerente◦Preenchedor◦Montador◦Desenvolvedor.

Manutenção dos grupos

Mapeamento dos Mapeamento dos TipoMembrosTipoMembros

O que é um TipoMembro?

TipoMembro: Visão / Modelo

O que é um Serviço?

Mapeamento e versionamento.

Serviços NativosServiços Nativos

Persistência

Dependência

Validação de dados

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.

Montagem do Montagem do ModeloModelo

Criação da TreeView.

Registro de Modelos.

Criação do Criação do DocumentoDocumento

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

Preenchimento do Preenchimento do DocumentoDocumento

Preenchimento dos Artefatos.Bloqueio de preenchimento

simultâneo.Visualização dos Artefatos.Ordem de execução dos

Serviços.

Impressão do Impressão do DocumentoDocumento

Exportação do Artefato

Latex (Serviço)

Gerenciamento do frameworkGerenciamento do framework

Logs de operações

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)

Estado AtualEstado Atual

85% dos requisitos definidos

50% da arquitetura definida

0% dos casos de uso especificados

0% de implementação

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