Descrição Principal

Este template descreve como o design pode ser organizado para ser entendido sob várias perspectivas. Também oferece sugestões de como os padrões e as descrições de interações pequenas e reutilizáveis podem ser usadas para minimizar a redundância.

É importante não pensar no design como "um documento". As informações do design que valem a pena manter durante algum tempo devem ter uma forma de vida longa. Esta forma pode ser um repositório de uma ferramenta de modelagem visual, subdiretórios de fotos dos diagramas em quadro branco capturadas com uma câmera digital ou um verdadeiro documento que forneça estrutura para imagens obtidas de uma miríade de fontes.

Este template descreve as informações que devem ser apresentadas. Normalmente, ele funciona melhor para apresentar informação gráfica (com a notação UML ou qualquer outra que seja inequívoca), ou pelo menos em palavras, em um nível abstrato. Você pode melhorá-lo com exemplos de código, mas é melhor não registrar o design exclusivamente a nível de código.

A estrutura do design é sugerida neste template.

Estrutura do design

[Descreva o design no nível mais alto. Este é comumente feito com um diagrama que mostra uma arquitetura em camadas.]

Subsistemas

[Sub-sistema1]

[Descreva o design de uma parte do sistema (um pacote ou componente, por exemplo). O design deve capturar tanto as perspectivas estáticas com as dinâmicas.

Quando capturar as descrições do comportamento dinâmico, procure por partes reutilizáveis de comportamento que você possa referenciar para simplificar o design das realizações de caso de uso.

Você pode subdividir esta seção em subseções de nível mais baixo para descrever subsistemas encapsulados de mais baixo nível.]

Padrões

[Padrão1]

Visão Geral

[Forneça uma visão geral do padrão, em palavras e de alguma forma consistente. A visão geral de um padrão pode incluir a intenção, a motivação e a aplicabilidade.]

Estrutura

[Descreva o padrão sob uma perspectiva estática. Inclua todos os participantes e como eles se relacionam, e aponte os dados e comportamentos relevantes.]

Comportamento

[Descreva o padrão sob uma perspectiva dinâmica. Mostre ao leitor como os participantes colaboram para dar suporte a vários cenários.]

Exemplo

[Muitas vezes, você pode apresentar melhor a natureza do padrão com um exemplo concreto adicional].

Realizações de caso de uso

[Realização1]

Visão dos participantes

[Descreva os elementos de design participantes sob uma perspectiva estática, fornecendo detalhes tais como comportamento, relacionamentos e atributos relevantes para esta realização de caso de uso].

Cenário base

[Para o fluxo principal, descreva como instâncias de elementos de design colaboram para realizar o caso de uso. Usando a UML, isso pode ser feito com diagramas de colaboração (seqüência ou comunicação)].

Cenários adicionais

[Para outros cenários que devam ser descritos para apresentar uma adequada quantidade de informações sobre como o comportamento do caso de uso será realizado, descreva como instâncias dos elementos de design colaboram para realizar o caso de uso. Usando a UML, você pode fazer isto com diagramas de colaboração (seqüência ou comunicação)].