Publicado a

Estado e diário de bordo, a memória do projeto

Dois documentos simples sustentam a continuidade de um projeto. O estado diz onde está hoje; o diário de bordo conta como chegou até aí. Um sobrescreve-se, o outro nunca se edita.

Linha de serviço Engenharia de Plataforma

Retomar sem reconstruir

Quem já deixou um projeto duas semanas e voltou a ele conhece a sensação: em que ia?, o que ficou a meio?, porque fiz isto assim? Agora multiplique-o por várias pessoas, vários projetos em paralelo e, cada vez mais, assistentes de IA que trabalham por sessões e não se lembram da anterior.

A continuidade não pode depender da memória. Tem de estar escrita, e num formato que se possa ler num minuto.

Dois documentos, duas funções

O que aconteceu e onde estamosDiário de bordo de seis sessões que só cresce e ficha de estado que se sobrescreve.PLATAFORMA · CONTINUIDADEO que aconteceu e onde estamosDIÁRIO DE BORDO · SÓ CRESCESessão 1Modelo criado; especificaçãoem rascunhoSessão 2Especificação aprovada (G1)Sessão 3Produto mínimo implementado emdesenvolvimentoSessão 4Falha de validação: ligaçãoquebrada, corrigidaSessão 5Implementado em aceitaçãoSessão 6Pendente: revisão de quem opediuESTADO · SOBRESCREVE-SEFaseAceitaçãoG1aprovadaG2pendenteG3—Bloqueioesperar revisãoSeguintevalidar em aceitaçãoO estado responde «onde estamos?» em segundos; o diário de bordo, «como chegámos?».Exemplo ilustrativoN100F · n100f.com

O estado é uma ficha curta e estruturada que se sobrescreve cada vez que algo muda:

  • Em que fase está a aplicação e que portas de aprovação passou.
  • Que marcos faltam e quais estão cumpridos.
  • O que bloqueia o avanço e quem tem de o resolver.
  • Qual é o passo seguinte.

O diário de bordo é um registo cronológico que só cresce: cada sessão de trabalho acrescenta uma entrada com o que se fez, o que se decidiu e o que falta. Nunca se corrige uma entrada anterior; se algo estava errado, uma entrada nova di-lo.

Porque dois e não um

Porque respondem a perguntas diferentes. O estado responde «onde estamos?» em segundos. O diário de bordo responde «como chegámos aqui?» quando é preciso entender uma decisão ou seguir o rasto de um erro. Misturá-los produz um documento demasiado longo para se ler depressa e demasiado editado para se confiar na sua história.

Regras práticas

  • Atualizam-se na mesma sessão, não «depois».
  • Vivem no repositório da aplicação, junto ao código.
  • O que está em bruto vai à parte: as saídas longas de comandos ou os dumps não sujam o diário de bordo; guardam-se no seu próprio ficheiro e citam-se.
  • São legíveis por máquinas: o estado tem estrutura fixa, para que a plataforma possa mostrar num painel em que ponto está cada aplicação.

Com a memória do projeto resolvida, é hora de construir. E construir bem começa por uma ideia muito concreta: o que se implementa tem de ser exatamente o que foi testado.


Como o aplicamos: Engenharia de Plataforma.

Se o seu custo cloud cresce sem que ninguém saiba porquê, ou a sua arquitetura depende de quem a montou, falemos.

Falemos