wiki:WF/Documentacaominimadeprojeto

Version 10 (modified by viani, 14 years ago) (diff)

--

Documentação Mínima de Projeto

Obviamente, não se pode desenvolver um sistema sem antes passar pela etapa de projeto. No caso do workflow, esta afirmação 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, considere investir um tempo na modelagem do sistema.

Sugere-se o uso da UML como ferramenta para produzir a documentação dos projetos de workflow. Contudo, nem todos os diagramas necessitam ser produzidos, apenas os principais. Esta simplificação está sendo sugerida para que o tempo de projeto fique mais curto, considerando-se que:

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

(É claro que cada organização é livre para escolher a ferramenta de modelagem que achar mais conveniente).

1. Levantamento e Análise de Requisitos

Nesta fase relacionam-se os produtos, relatórios e informações que devam ser fornecidos pelo sistema.

2. Diagrama de Casos de Uso

Com base nos requisitos projeta-se o Diagrama de Casos de uso, que identifica os atores e as principais funcionalidades do sistema, e o relacionamento entre elas.

3. Descrição dos Casos de Uso

Para cada caso de uso deve-se produzir um relatório descritivo do caso, que servirá de base para o desenvolvimento das atividades do processo.

4. Diagrama de Classes

Diagrama muito importante que apresenta o relacionamento entre as classes do sistema, seus atributos e métodos, e como as classes relacionam-se entre si.

5. Fluxo do Processo

Diagrama das atividades do processo e as transições entre elas.

6. Diagrama Entidade-Relacionamento

Este diagrama refere-se à implementação do banco de dados, representando as tabelas, suas colunas, índices, restrições e relacionamentos.

Softwares recomendados para produção dos documentos

Toda esta documentação necessita ficar armazenada para consulta fácil e atualização constante. Uma sugestão pode ser o Software Trac (o mesmo utilizado aqui no expressolivre.org), que disponibiliza um ambiente muito bom para o acompanhamento de um projeto, em especial o wiki do Trac que controla o versionamento dos documentos. Outra opção seria criar um repositório no SVN para armazenar a documentação.

FaseSoftware
Levantamento de requisitos wiki ou brOffice
Diagrama de Casos de Uso Jude
Descrição dos Casos de Uso wiki ou brOffice
Diagrama de Classes Jude
Fluxo do Processo Dia
Der DbDesigner