Diagramas e documentação de arquitetura

Públicos diferentes precisam de diferentes tipos de documentação. Se você é o responsável pela arquitetura, deve criar uma documentação que mostre o projeto de várias altitudes que correspondam ao nível de detalhe necessário para cada público. Sem várias elevações, seus diagramas serão excessivamente complicados e detalhados para alguns públicos ou não terão os detalhes necessários para outros. Nenhum diagrama pode ser suficiente para todos esses propósitos.

A maioria dos executivos precisa apenas de uma visão de 30.000 pés. Este tipo de documentação deve revelar os maiores componentes do sistema, seus propósitos e relacionamentos. Também pode indicar de alguma forma o nível de complexidade dos componentes individuais, ou quais equipes são responsáveis ​​por eles, incluindo quaisquer fornecedores externos. Deve indicar quaisquer dependências operacionais rígidas. Esse nível de detalhe dá ao executivo a capacidade de ver o quadro geral, de modo que ele ou ela possa formar um modelo mental do programa geral.

Os gerentes de engenharia precisam de uma visão de 10.000 pés. Esta visualização expõe muito mais detalhes. Pode ser possível ver alguns subcomponentes dentro dos componentes maiores, bem como as relações entre essas peças internas. Ele pode mostrar alguns detalhes sobre os protocolos usados ​​nas interconexões de componentes, bem como a direção de dependência das relações entre os componentes. O objetivo disso é que o gerente de engenharia seja capaz de identificar com quais equipes sua equipe deve interagir para planejamento, integração e teste, de modo que as dependências ao longo do caminho crítico sejam entendidas no início do processo.

Os engenheiros precisam de uma visão mais detalhada do projeto. O quão detalhado deve ser depende muito do nível de habilidade dos engenheiros e se eles também são parcialmente responsáveis ​​pelo projeto, ou se estão executando seu projeto como uma especificação. Isso sempre será diferente contextualmente com base em onde você está empregado e com quais equipes está trabalhando.