Requisitos de documentação
I. Estrutura Típica do Sítio Web
Contém a apresentação do projecto e da equipa de projecto, o historial
do projecto e acesso à informação produzida no âmbito do projecto
(nomeadamente aos artefactos: documentos e produtos).
Contém ainda a apresentação promocional da aplicação desenvolvida.
Esta informação divide-se entre:
- a página do projecto (i.e. da empresa que desenvolve o
projecto) contendo a apresentação dos membros da equipa, o historial
do projecto, ligações para os artefactos produzidos, etc...
- página da aplicação contendo a apresentação e a promoção da
aplicação e, se aplicável, uma ligação para a utilização
do produto desenvolvido.
As páginas Web desenvolvidas devem seguir boas práticas de
desenvolvimento por forma a respeitar os princípios
sobre "Acessibilidade e Facilidade de Utilização".
II. Estrutura Típica do Relatório de Especificação de Requisitos
Contém análise de requisitos acordados com o cliente.
- Introdução
- Objectivo do projecto
- Enquadramento do sistema a desenvolver no negócio/organização
- Riscos
- Requisitos do sistema
- Descrição geral dos requisitos do sistema a desenvolver (necessidades do utilizador/cliente), não se limitando ao software, em linguagem corrente facilmente compreendida pelos utilizadores e clientes finais
- Os requisitos podem ser funcionais ou não funcionais, mínimos ou não-mínimos.
- Modelo de casos de utilização
- Visão geral
- Com um ou mais diagramas de casos de utilização e descrição genérica
- Actores
- Descrever cada um dos actores
- Casos de utilização
- Uma secção para cada caso de utilização
- Os casos de uso descrevem implicitamente os requisitos funcionais e podem ter associados alguns requisitos não funcionais
- Descrever a(s) sequência(s) de funcionamento
- Opcionalmente, descrever graficamente sequência(s) de funcionamento por diagramas dinâmicos
- Apresentar esboços ou protótipos de interfaces para o utilizador
- Modelo de objectos do domínio (vocabulário do domínio)
- Glossário (dicionário de termos do vocabulário do domínio)
III. Estrutura Típica do Relatório de Desenho de Alto Nível
Este relatório contém a definição da arquitectura do sistema a desenvolver.
- Introdução
- Arquitectura lógica
- refere-se à decomposição hierárquica do sistema em módulos lógicos (pacotes de classes) e à especificação dos interfaces e dependências entre módulos lógicos
- descrita por diagrama de pacotes
- a decomposição pode fazer-se por camadas (decomposição horizontal), por sub-sistemas (decomposição vertical) ou por ambos
- Arquitectura física
- refere-se à organização do software em componentes de run-time (módulos físicos) e à topologia do hardware (nós e conexões) sobre a qual esses componentes são distribuídos
- descrita por diagramas de componentes e de distribuição (deployment)
- convém indicar a localização dos componentes de run-time nos nós de hardware, e relacionar os módulos lógicos com os componentes
- se possível e aplicável, especificar os interfaces implementados (exportados) e usados (importados) por cada componente
- Arquitectura tecnológica
- Escolha de tecnologias a usar na implementação
IV. Estrutura Típica do Relatório de Desenvolvimento
Este relatório é composto pelas seguintes partes, que podem ser
apresentadas como documentos separados:
1. Revisão do relatório de especificação de requisitos (opcional)
2. Revisão do relatório de definição da arquitectura (opcional)
3. Relatório de projecto detalhado:
- Descrição de componentes
- Especificação: serviços/dados disponibilizados e serviços requeridos
(no caso de componentes visuais, a especificação do interface para o
utilizador passa para o manual do utilizador)
- Implementação: aspectos de concepção interna (algoritmos, estruturas
de dados, etc.)
- algoritmos podem ser descritos através de diagramas de actividades
- ciclos de vida de objectos podem ser descritos por diagramas de estados
- Testes: informação sobre testes unitários (procedimentos de teste, resultados de
testes, etc.)
- Aplicações: exemplos / casos de utilização
- Realização de casos de utilização
- Parte estática: objectos envolvidos (objectos de interface, em
memória (de controlo) e persistentes), incluindo objectos internos ao
sistema
- refinamento do modelo de domínio parcial apresentado junto com
cada caso de utilização no relatório de especificação de
requisitos
- Parte dinâmica: diagramas de interacção (sequência, colaboração,
actividades, ...)
- refinamento de diagramas dinâmicos apresentados junto com cada
caso de utilização no relatório de especificação de requisitos,
acrescentando objectos internos ao sistema
- Informação sobre testes de integração: procedimentos, resultados de
teste
- Estado da implementação (casos de utilização não implementados, bugs
conhecidos, etc.)
1. Revisão dos Requisitos:
Resumo das alterações em relação ao Relatório de Requisitos.
2. Revisão de Arquitectura:
Resumo das alterações em relação ao Relatório de Arquitectura.
3. Projecto Detalhado:
Especificação e implementação de componentes comuns (por exemplo o(s)
componente(s) de acesso a dados): algoritmos
(Diagramas de actividades), ciclos de vida (Diagramas de Estados);
Realizações de Casos de Uso: Parte Estática (Diagramas de Classes) e
Parte Dinâmica (Diagramas de Sequência)
4. Caso de Uso em XML:
Escrita de XML, DTD ou Schema, XSL para apresentação.
5. Estado da Implementação.