1 - A documentação da arquitetura – visão geral

É sempre útil para uma organização ter um modelo de documento disponível para a elaboração da documentação do projeto. Modelos de documentos ajudam a reduzir o tempo de início para um projeto, fornecendo estruturas prontas para que possam ser usadas pelos membros.

Uma vez que o uso dos modelos se torna institucionalizado, a familiaridade adquirida com a estrutura do documento ajuda na captura eficiente de detalhes do projeto de design. Os modelos de documentos também ajudam no treinamento de novos funcionários em especial os desenvolvedores que passam a pensar e questionar o desenvolvimento de seus sistemas.

A estrutura de documentação a seguir pode ser utilizada para a captura de uma arquitetura. Para implantar essa template em uma organização, deve-se elaborar um texto explicativo com exemplos do tipo de informação esperada em cada seção.

Template de Documentação de Arquitetura Nome do Projeto: XXX Contexto
  1. Projeto
  2. Requisitos de Arquitetura
    1. Visão Geral dos objetivos-chave
    2. Casos de Uso de Arquitetura
    3. Partes Interessadas Requisitos arquitetônicos
    4. Restrições
    5. Requisitos não funcionais
    6. Riscos
  3. Solução
    1. Padrões de Arquitetura relevantes
    2. Visão Geral da Arquitetura
    3. Visão estrutural
    4. Visão de Comportamento
    5. Questões de Implementação
  4. Análise Arquitetura
    1. Cenário
    2. Riscos

Para entendermos melhor como a documentação da arquitetura funciona, vamos mergulhar na documentação do projeto. Vamos chamar este projeto de ICDE.

Copyright © 2016 AIEC.