<Nome do Projeto>
Documento de Arquitetura do Recurso
[Esta seção apresenta uma visão geral do Documento de Arquitetura de Recurso inteiro. Ela inclui o objetivo, o escopo, as definições, os acrônimos, as abreviações, as referências e a visão geral do Documento de Arquitetura de Recurso.]
Este documento fornece uma visão geral arquitetural abrangente do <nome do Recurso>. Ele pretende capturar e transmitir as decisões arquiteturais significativas que foram tomadas em relação à composição dos artefatos individuais que devem ser incluídos no recurso.
[Esta seção descreve os requisitos e objetivos do recurso que tem algum impacto sobre a arquitetura; por exemplo, facilidade de uso, nível de habilidade necessário, uso de um produto off-the-shelf ou de um recurso reutilizável existente, uso de uma representação padrão específica para o recurso, etc. Além disso, captura as restrições especiais que possam ser aplicadas, incluindo estratégia de design e implementação, ferramentas de desenvolvimento, estrutura de equipe, planejamento e artefatos existentes.]
[Esta seção descreve os ambientes/contextos aos quais o recurso deve ser aplicado. Isso inclui o contexto de desenvolvimento, o contexto de implantação, o contexto de domínio comercial, etc.
Alguns contextos possíveis a serem considerados para capturar valores são:
- Contexto de Implantação: Identifica os ambientes de servidor e de tempo de execução para os quais o recurso foi destinado, como "websphere"
Contexto de Desenvolvimento: Identifica o ambiente de desenvolvimento no qual o recurso foi destinado para ser desenvolvido/estendido
- Contexto de Domínio: Identifica o domínio de negócios do recurso, como "seguro"
- Contexto de Escopo de Reutilização: Identifica, de forma organizacional, onde o recurso foi destinado para ser reutilizado, como equipe de projeto, departamento e empresa
- Contexto de Teste: Identifica os contextos nos quais o recurso deve ser testado, como os seguintes: "teste de carregamento", "teste de desempenho", "teste funcional"]
[Esta seção descreve os relacionamentos que o recurso pode ter com outros recursos. Por exemplo, o recurso pode depender de outro para oferecer um serviço específico, ou pode depender de outro recurso que está sendo aplicado antes que o recurso em si seja aplicado.]
[Esta seção descreve como o consumidor do recurso deve utilizar o recurso. Pode ser considerada um modelo de uso inicial para o recurso.]
[Esta seção contém o Modelo de Caso de Uso para o recurso, e lista os agentes (por exemplo, os consumidores do recurso) do recurso e os casos ou cenários de uso (descrições de como o agente utiliza o recurso). Deve haver uma correspondência direta entre os casos de uso e os recursos da Visão do Recurso.]
[Esta seção ilustra como o recurso realmente funciona, mostrando algumas realizações de caso (ou cenário) de uso selecionadas, e explica como os diversos artefatos do recurso contribuem com sua funcionalidade.
No contexto de um recurso reutilizável, as realizações de caso de uso descrevem como os artefatos do recurso contribuem para a funcionalidade descrita no caso de uso.]
[Esta seção lista a prioridade relativa de cada característica do recurso descrita na seção Modelo de Uso. Essas informações são utilizadas durante o planejamento de iteração para o desenvolvimento dos artefatos do recurso.]
[Esta seção descreve a organização lógica geral do recurso e lista os artefatos contidos no recurso. Além de documentar a hierarquia de pacotes, o fundamento lógico para a organização deve ser documentado.]
[Esta seção descreve a organização lógica geral do recurso, incluindo a hierarquia de pacotes e os relacionamentos importantes entre esses pacotes]
[Para cada pacote, inclua uma subseção com o respectivo nome, uma breve descrição e uma lista com todos os artefatos do recurso (e os possíveis sub-pacotes) contidos nesse pacote.
Para cada artefato do recurso do pacote, inclua o respectivo nome, uma breve descrição e os relacionamentos com outros artefatos do recurso.]
[Esta seção descreve a organização física geral do recurso (por exemplo, os arquivos e os diretórios do recurso).
Geralmente, a organização física do recurso não é igual à organização lógica, pois a organização física do recurso é impactada pela escolha do formato a ser utilizado para empacotar o recurso (por exemplo, a Especificação de Recurso Reutilizável). Assim, a organização física geralmente não é definida "diretamente", e sim, documentada exatamente antes do empacotamento do recurso (ou imediatamente após a conclusão dele).
[Descreve a organização física geral do recurso. Lista os diretórios físicos que contêm os arquivos do recurso, além de qualquer "regra" que governa quais arquivos podem ser incluídos em qual diretório.
Se a representação de recurso padrão for selecionada para o recurso, o efeito sobre a organização física do recurso deverá ser descrito aqui.]
[Para cada diretório físico, inclua uma subseção com o respectivo nome, uma breve descrição e uma lista com todos os arquivos (e possíveis subdiretórios) contidos no diretório.]
[Se o recurso oferecer opções de customização explícita para contextos específicos (por exemplo, instanciação da estrutura de arquitetura com um banco de dados de backend específico, ou instanciação de um serviço de implantação para um produto específico), então essa seção deve descrever essas opções de customização.
Esta seção deve descrever explicitamente o que pode ser customizado e fornecer orientações para executar a customização. Por exemplo, no caso de um recurso que represente um gabarito ou uma estrutura, esta seção deve descrever os parâmetros formais que devem ser definidos como parâmetros reais como parte da instanciação do recurso, além de fornecer sugestões sobre o que deve ser definido. Instruções detalhadas de uso não são necessárias aqui, pois serão fornecidas na documentação completa do recurso. O objetivo é a identificação desses aspectos do recurso que devem ser customizados.