Modelo de registro de decisão de arquitetura (ADR)

Este é um modelo para ADR do EdgeX Foundry.

Liste os autores da submissão do ADR.

Formato:

Registro de mudanças

Liste as mudanças no documento, incluindo estado, data e URL do pull request.

O estado é um destes: pending, approved, amended, deprecated.

A data é uma string ISO 8601 (YYYY-MM-DD).

O PR é o pull request que submeteu a mudança, incluindo informações como o diff, os colaboradores e os revisores.

Formato:

Liste todos os documentos de casos de uso / requisitos relevantes.

O ADR exige pelo menos um caso de uso relevante e aprovado.

Formato:

Adicione explicações se o ADR não atender a todos os requisitos de um caso de uso.

Descreva:

como o design é arquiteturalmente significativo, justificando um ADR (em vez de uma simples issue e PR para corrigir um problema)
a abordagem de design em alto nível (detalhes descritos no design proposto abaixo)

Detalhes do design (sem entrar na implementação sempre que possível).

Esboço:

serviços/módulos que serão impactados (alterados)
novos serviços/módulos a serem adicionados
impacto em modelos e DTOs (mudanças/adições/remoções)
impacto na API (mudanças/adições/remoções)
impacto na configuração geral (criação de novas seções, mudanças/adições/remoções)
impacto em devops

Documente alternativas, preocupações, questões acessórias ou relacionadas e perguntas que surgiram no debate do ADR.

Indique se/como foram resolvidas ou atenuadas.

Documente qualquer detalhe de implementação importante acordado, ressalvas, considerações futuras e questões de design remanescentes ou adiadas.

Documente qualquer parte dos requisitos não satisfeita pelo design proposto.

Liste quaisquer ADRs relevantes, como uma decisão de design de um subcomponente de um recurso, um design obsoleto em decorrência deste design etc.

Formato:

Liste referências adicionais.

Formato: