Conn2Flow
Navegação das docs

SDD

req-151: Poda e modularização de documentação raiz (README e CHANGELOG) para preservação de contexto de agentes

Atualmente, agentes de IA enfrentam um consumo excessivo de contexto toda vez que precisam consultar ou referenciar os arquivos de documentação da raiz: 1. READMEs: - README.md…

  • Status do intake: implemented-pending-homologation

  • Data: 2026-08-31

  • Origem: diretiva do Engenheiro Chefe durante o ciclo de release 2.10.0

  • Classificação: governança de documentação, eficiência de contexto de IA, arquitetura documental

  • Batch: BATCH-153

  • Promovido de: BL-013


1. Contexto e Motivação

Atualmente, agentes de IA enfrentam um consumo excessivo de contexto toda vez que precisam consultar ou referenciar os arquivos de documentação da raiz:

  1. READMEs:

    • README.md (605 linhas) e README-PT-BR.md (612 linhas) na raiz do repositório acumulam tabelas de arquitetura, guias de diretórios e manuais exaustivos.

  2. CHANGELOGs:

    • CHANGELOG.md (409 linhas) e CHANGELOG-PT-BR.md (730 linhas) contêm todas as versões históricas desde a versão inicial 1.0.0.


2. Escopo da Solução

Parte A: Modularização e Enxugamento dos READMEs

  1. Raiz concisa (README.md e README-PT-BR.md):

    • Manter um resumo executivo objetivo (<150 linhas): proposta de valor, badges, destaques da última versão (v2.10.0), instruções rápidas de instalação com link direto para o instalador-v2.0.0, comandos rápidos de teste (composer test, npm run test) e atalhos diretos para as seções especializadas.

  2. Transferência de manuais para ai-workspace/:

    • Estrutura completa de diretórios do repositório, manuais detalhados de desenvolvimento, tarefas do VS Code e ambiente Docker migrados para guias dedicados em:

      • ai-workspace/en/docs/ (referenciada pelo README.md)

      • ai-workspace/pt-br/docs/ (referenciada pelo README-PT-BR.md)

Parte B: Poda e Arquivamento dos CHANGELOGs

  1. Raiz focada no presente (CHANGELOG.md e CHANGELOG-PT-BR.md):

    • Reter na raiz apenas a versão atual ([2.10.0]) e as versões da série anterior ([2.9.x]), com link explícito apontando para o arquivo histórico.

  2. Arquivamento histórico:

    • Mover as versões anteriores (v2.8.x para trás) para arquivos de histórico dedicados:

      • ai-workspace/en/docs/changelogs/CHANGELOG-archive-v2-legacy.md (e CHANGELOG-archive-v1.md se aplicável).

      • ai-workspace/pt-br/docs/changelogs/CHANGELOG-archive-v2-legacy.md.

Parte C: Validação e Paridade com o Release Gate

  1. Contrato do Release Gate mantido:

    • Os arquivos da raiz continuam contendo a menção v2.10.0, instalador-v2.0.0 e a entrada [2.10.0] no changelog, garantindo que o comando c2f manager:release e o validador da extensão (inspectReleaseDocumentContents) permaneçam 100% verdes (issues: []).


3. Critérios de Aceite para o Agente Executor

  • [x] README.md e README-PT-BR.md da raiz reduzidos para resumo executivo objetivo (<150 linhas).

  • [x] Conteúdo detalhado migrado e organizado em ai-workspace/en/docs/ e ai-workspace/pt-br/docs/.

  • [x] CHANGELOG.md e CHANGELOG-PT-BR.md podados mantendo apenas a linha corrente (2.10.x) e a anterior (2.9.x), com versões mais antigas arquivadas nos respectivos subdiretórios de ai-workspace/.

  • [x] Links relativos entre a raiz e os novos arquivos em ai-workspace/ testados e válidos.

  • [x] Verificação de release sem regressão: script de validação de documentos roda com zero issues.

  • [x] Suítes de testes automatizados (composer test e npm run test) continuam íntegras.

O Futuro é Híbrido: Humano + IA.

O Conn2Flow é a ferramenta. Se você precisa do Arquiteto para desenhar a estratégia da sua empresa usando essa tecnologia...

Contrate Consultoria Especializada