Como o documento de relatório de UML está organizado

Visão geral

A página Visão geral é a primeira página do documento de relatório e traz uma lista de todos os pacotes com um resumo de cada um deles. Esta página também pode conter uma descrição geral do conjunto de pacotes.

Pacote

Cada pacote tem uma página que contém uma lista de suas classes, interfaces e outros elementos, com um resumo de cada um deles. Esta página pode apresentar as categorias na seguinte ordem:

• Interface
• Classe
• Classificador de derivação
• Tipo de dados
• Enumeração
• Estereótipos
• Atividade
• Ator
• Nó
• Artefato do arquivo-fonte
• UseCase
• Grupo de atividades
• Nó final
• FinalState
• Nó de bifurcação
• InitialNode
• Nó de chamada
• Linha de vida

Elemento

Cada classe, interface, classe aninhada e interface aninhada tem sua própria página à parte. Cada uma dessas páginas posssui três seções formadas por uma descrição da classe/interface, tabelas de resumo e descrições detalhadas dos membros:

• Diagrama de herança de classe
• Subclasses diretas
• Todas as subinterfaces conhecidas
• Todas as classes de implementação conhecidas
• Declaração de classe/interface
• Descrição de classe/interface

• Resumo da classe aninhada
• Resumo do atributo
• Resumo do construtor
• Resumo da operação
• Resumo do estereótipo
• Resumo do valor com marca
• Resumo da restrição
• Resumo do diagrama

• Detalhe do atributo
• Detalhe do construtor
• Detalhe da operação

Cada entrada de resumo contém a primeira frase da descrição detalhada de tal item. As entradas de resumo estão em ordem alfabética, enquanto que as descrições detalhadas estão na ordem em que aparecem no código-fonte. Isto mantém os agrupamentos lógicos estabelecidos pelo programador.

Diagrama

Cada diagrama tem uma página para exibir sua imagem no formato png. Ao clicar em um elemento na página inteira do diagrama, você será levado à página de detalhes do elemento.