logo hsb.horse

Registro de Decisão de Arquitetura

Convenções de ADR

Definir convenções de nomenclatura, estratégia de idioma e esquema de listagem.

Aceito #docs #process

Convenções de ADR

Decisão

  • Adotar docs/ADR/YYYY-MM-DD-NNN-<slug>.<lang>.md.
  • Usar valores de lang como ja / en, permitindo futuras adições.
  • Manter um arquivo por decisão por idioma.

Contexto

Precisávamos de um esquema de nomenclatura que ordenasse cronologicamente e mapeasse idiomas com clareza.

Justificativa

  • Data e sequência juntas tornam explícitos cronologia e número da decisão.
  • .<lang> torna o idioma explícito.
  • Slugs curtos mantêm as listas legíveis.

Consequências

Criar arquivos pareados ja e en com a mesma data e sequência.