Ir para o conteúdo

Mudanças

Este é o lugar das decisões que mudam só o backend. Demanda que também obriga um front fica no wmreis-docs. Uma IA que for alterar o serviço lê o índice da prateleira correspondente e os registros aceitos daquele assunto. O código privado não é a fonte da decisão: o registro publicado é.

Cada mudança usa um tipo só. Se a pergunta ainda está aberta, é uma RFC. Se a escolha já foi feita, é um ADR. Se o texto descreve como a solução funciona, é um design doc. Se descreve o problema de produto e o que entra na entrega, é um PRD.

Tipo Pergunta que responde Quando escrever
RFC O que estamos propondo, e quais alternativas existem? Antes de fechar a decisão, quando há mais de um caminho
ADR O que foi decidido, e por quê? Quando a escolha fica vigente e não deve ser reaberta sem um registro novo
Design doc Como a solução funciona? Quando a decisão precisa de fluxo, contrato, dado ou sequência
PRD Qual problema de produto vamos resolver, e o que fica de fora? Quando a mudança nasce de uma necessidade de usuário ou de negócio

Ordem de leitura para uma mudança nova

  1. Procurar nesta seção um registro do mesmo assunto.
  2. Se a decisão vigente contradiz a mudança, a mudança espera um ADR novo que substitua o anterior.
  3. RFC aceita vira ADR. ADR que precisa de detalhe aponta para um design doc. PRD aprovado aponta para a RFC ou o ADR que o implementa.

O que já existe

Os ADRs de backend cobrem stack, versionamento, logs, CQRS, os contratos do PDV e o acesso ao DynamoDB. O design doc do cashbook descreve o serviço da fase 1: três livros, tipos do importador, upload lido no bank e classificação no cashbook. O acesso ao DynamoDB vale para lista de tela: consulta por chave, sem varrer a tabela no clique. O ADR de 13/10 aceita a ordem: primeiro um cliente só, depois cada lista na própria fase. O desenho das fases traz o aceite de cada issue. A RFC está aceita. A demanda que também muda o admin está no ADR da fase 1. O primeiro corte visível está no ADR do lembrete e no desenho Lembrete. O desenho da tela está no admin-docs. A conta bancária fica no bank e o livro no cashbook, no ADR e no desenho Conta do bank. A visão de negócio continua como contexto geral da plataforma.