Ideia

Uma documentação em linguagem natural existe para os leitores que não têm acesso ao código, não pela qualidade da sua informação

Info

Escrito originalmente em francês. Traduzido por IA — o sentido foi preservado, não a prosa.

Ideia principal

A especificação, a documentação de suporte, o documento de enquadramento são defendidos com frequência pela sua clareza: são compreensíveis por todo mundo, utilizáveis em reunião, compartilháveis com os times, aproveitáveis sem competência técnica. Essas qualidades são reais, mas são qualidades de acesso, não qualidades de informação.

A razão de ser dessa camada é uma restrição de leitores: a maior parte dos product managers, dos vendedores e dos agentes de suporte não trabalha dentro do repositório. Era preciso, então, um objeto intermediário, menos confiável que o código mas legível por quem decide. Enquanto essa restrição valia, a camada em linguagem natural era a menos ruim das soluções disponíveis — e ninguém precisava escolher entre confiabilidade e legibilidade, já que apenas uma das duas estava ao alcance.

O que vem daí: no dia em que o acesso à fonte deixa de ser reservado a quem sabe lê-la, o argumento que justificava a camada desaparece, enquanto a camada continua no lugar.

Por que isso importa

É isso que impede de ler o abandono progressivo da documentação como um relaxamento. A camada não era defendida por si mesma, ela compensava uma incapacidade de acesso; quando a compensação vira algo facultativo, o artefato perde seu fundamento sem que ninguém tenha decidido isso.

Isso também dá um teste para aplicar a qualquer documento intermediário: a qual incapacidade de acesso ele responde? Se a resposta for "a nenhuma", ele duplica uma informação que já existe em outro lugar, mais bem mantida.

Nuances e limites

O acesso não é tudo. Um documento em linguagem natural carrega também a intenção e o contexto de negócio, que o repositório não contém — essa parte não desaparece quando a barreira de acesso cai.

E poder ler o código por meio de uma ferramenta não é o mesmo que entendê-lo: a barreira se desloca para a cultura técnica em vez de sumir.

Questões em aberto

  • Que parte de uma especificação depende do contexto de negócio e, portanto, sobrevive à queda da barreira de acesso?