wiki:WF/Documentacaominimadeprojeto

Version 1 (modified by trac, 17 years ago) (diff)

--

Obviamente, não se pode desenvolver um sistema sem antes passar pela etapa de projeto. No caso do workflow, esta premissa também é válida. Mesmo para processos simples é necessário seguir uma metodologia de desenvolvimento de sistemas, sob pena de cair em erros de implementação, por falta de planejamento. Portanto, antes de começar a codificar o seu processo, atente para as recomendações descritas abaixo.

Está sendo sugerida a MDS - Metodologia de Desenvolvimento de Serviços, do framework Pinhão, como base para o desenvolvimento de processos de workflow. Na prática foram feitos alguns cortes na metodologia original, para torna-lá mais adequada para o workflow. Isto não significa que etapas importantes foram suprimidas, mas apenas que ocorreu uma reorganização para tornar o tempo de projeto mais curto. Foi tomada esta decisão levando em consideração os seguintes fatores:

  • Geralmente o projetista também é o implementador;
  • Os processos de workflow, geralmente, são de complexidade baixa ou média.

Documento do Projeto

Deve-se redigir um documento de projeto, com no mínimo, os ítens listados abaixo.

1 Apresentação

2 Caracterização da Organização

  2.1 Identificação

3 Caracterização do Problema

4 Situação Atual

5 Requisitos

6 Funcionalidades

  6.1 Diagrama de Fluxo de Atividades

  6.2 Diagrama de Casos de Uso

  6.3 Descrição dos Casos de Uso

  6.4 Diagrama de Entidades e Relacionamentos

7 Proposta de Solução

8 Esforço de Desenvolvimento, Prazos e Custos.

9 Benefícios

10 Estratégias de Abordagem

11 Equipe de Trabalho - Papéis

12 Atividades e Prazos

Para facilitar, está disponível um  modelo de documento de Projeto.

No cálculo do esforço de desenvolvimento (ítem 8), deve-se seguir as orientações do documento  Métrica para Estimativa de Projetos, também do Framework Pinhão.

Documentos dos Casos de Uso

Para cada caso de uso identificado no relatório do projeto, deverá ser produzido um documento de especificação, conforme exemplificado neste  modelo

Repositório para a documentação

Todos os documentos produzidos deverão ser armazenas no cvs do servidor de desenvolvimento do workflow, segundo a árvore de diretório abaixo:

      Módulo
        +- doc
            +- UCS
                +- ucs_atividade.odt
                +- ...
            +- der_modulo.png
            +- der_modulo.xml
            +- fluxo_modulo.dia
            +- fluxo_modulo.png
            +- projeto_modulo.odt
            +- ucs_modulo.jude
            +- ucs_modulo.png

onde:

Módulo = nome do processo

UCS = pasta para armazenamento dos documentos de caso de uso

atividade = nome de uma atividade do processo

der_modulo = arquivos do diagrama-entidade-relacionamento

fluxo_modulo = arquivos do fluxo de atividades

projeto_modulo = arquivo principal do projeto

ucs_modulo = arquivos do diagrama de casos de uso

Softwares recomendados para produção dos documentos

FaseSoftwareInstalação
ProjetoBrOffice.orgapt-get install broffice-celepar
DerDbDesignerapt-get install dbdesigner4
FluxoDiaapt-get install dia
Casos de usoJudeapt-get install jude