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 de projecto, contendo a
apresentação, a equipa, o historial, ligações para os artefactos, e a
página da aplicação, contendo a apresentação, a promoção e 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 Desenvolvimento
- 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)
- 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
- Descrição da implementação
- Estado da implementação (casos de utilização não implementados, bugs
conhecidos, etc.)
- Conclusões