FrameCode VibeWork
Buy me a coffee

Guia Completo do Framework

Version: V0.5.0+

1.1 Visão geral

FrameCode VibeWork é um framework de desenvolvimento assistido por IA orientado por documentação, criado para reduzir perda de contexto, controlar escopo e padronizar execução técnica entre humanos e agentes.

O que ele é

  • Um framework de governança operacional e técnica.
  • Uma estrutura de memória incremental baseada em Markdown.
  • Um padrão de trabalho com rastreabilidade completa por versão.

O que ele não é

  • Não é um framework de frontend/backend com runtime próprio.
  • Não substitui Git, revisão ou decisão arquitetural humana.
  • Não depende de scripts automáticos para governança.

1.2 Problema resolvido

Sessões com IA sofrem com perda de contexto, repetição de erros e mudanças sem trilha de auditoria. O framework estrutura esse processo para tornar a execução previsível e auditável.

Dor comumResposta no framework
Contexto se perde entre sessõesSíntese AICC em wiki/sessions/ e ingestão seletiva.
Escopo muda sem controleRegra obrigatória de plano em Plans/ antes de qualquer modificação.
Mudanças sem histórico claroChangelog versionado em changelogs/Vx.y.z.md.
Conhecimento técnico dispersoLLM Wiki estruturada em wiki/ (patterns, decisions, releases, sessions).

1.3 Ciclo de funcionamento

Fluxograma operacional do framework (mesma lógica do README), mostrando o ciclo completo de execução e retroalimentação de contexto.

Regra central: nenhuma alteração funcional, visual, estrutural ou documental deve ocorrer sem plano correspondente.

2.1 Arquitetura documental

A aplicação funciona como uma malha de documentos com responsabilidades explícitas.

CamadaDocumento / PastaResponsabilidade
OperaçãoAGENTS.mdGuia principal de execução para humanos e IA.
IdentidadeMANIFEST.mdEstado oficial, escopo resumido e riscos principais.
MudançasPlans/Ciclo de vida de cada alteração.
Versõeschangelogs/Registro formal por versão.
Memóriawiki/Conhecimento técnico incremental e navegável.
Padrões IAskills/Checklists de alta densidade carregados sob demanda.
Templatesgovernance/Estruturas vazias reutilizáveis para novos projetos.

2.2 Governança por planos

Fluxo obrigatório

  1. Criar plano em Plans/pending/.
  2. Mover para Plans/in_progress/ ao iniciar.
  3. Executar somente o escopo aprovado.
  4. Atualizar changelog da versão.
  5. Fechar plano em Plans/completed/ ou discontinued/.

Campos mínimos do plano

  • Prioridade P1..P5 e risco R1..R5
  • Versão atual e esperada
  • Critérios de aceite
  • Plano de testes
  • Status e evidências de validação

2.3 Versionamento e release

O framework segue Vx.y.z e exige changelog para toda mudança em arquivo versionado.

  • Major: quebra de compatibilidade, mudança arquitetural ampla.
  • Minor: novas capacidades e fluxos relevantes.
  • Patch: correções e melhorias documentais/processuais.
Estados de release: in_preparation, in_validation, published, canceled.
Uma versão só pode ser published quando os planos citados estiverem em Plans/completed/ e as validações estiverem registradas.

2.4 IA, AICC e ASE

AICC (compressão de contexto)

  • Gera síntese cronológica por sessão em wiki/sessions/S*.md.
  • Reduz custo de tokens com handoff estruturado.
  • Permite retomar trabalho sem reprocessar todo o repositório.

ASE (motor de habilidades)

  • Carrega skills sob demanda (JIT), não no prompt inicial.
  • Inclui habilidades de release, lint wiki, commits e formatação.
  • Melhora consistência e reduz ruído de contexto.

Referências: AI.md, CONTEXT_MAP.md, skills/README.md, wiki/schema.md.

2.5 Modelos locais: parâmetros e janela de contexto

Recomendação prática para uso do framework com modelos locais, com base no volume documental do próprio FCVW e no custo de contexto por sessão.

FaixaParâmetrosJanela de contextoUso recomendado no framework
Mínimo operacional7B-8B16kCorreções curtas, ajustes em 1-3 arquivos, tarefas objetivas com contexto enxuto.
Recomendado geral14B-32B32k-64kFluxo completo com plano + changelog + wiki, revisões médias e múltiplos documentos.
Alta confiabilidade32B-70B+64k-128kRefatorações amplas, auditorias, releases complexos e sessões longas sem perda de coerência.
  • Para operar com estabilidade, reserve folga de contexto de 40% a 60% para histórico, diffs e respostas longas.
  • No FCVW, a carga inicial varia por tipo de sessão; sem compressão pode chegar a ~8.5k tokens, então 16k é o piso seguro para uso real.
  • Para desempenho consistente em tarefas de governança e escrita técnica estruturada, a faixa 14B+ tende a reduzir retrabalho.
Inferência aplicada ao framework: estas faixas foram definidas a partir dos cenários de ingestão e ciclo operacional documentados no próprio repositório.

3.1 Segurança e dados

  • Não versionar credenciais, dados privados e artefatos temporários.
  • Validar path traversal em qualquer leitura/escrita de caminhos dinâmicos.
  • Manter .env e variantes fora do versionamento (com .env.example permitido).
  • Registrar limitações ou riscos residuais ao fechar planos.

3.2 Validação e auditoria

A validação é proporcional ao risco e sempre precisa ser registrada com evidência.

RiscoNível mínimo esperado
R1 / R2Verificações locais + revisão de links/consistência.
R3Validação de fluxos compartilhados e regressão local.
R4 / R5Validações completas com foco em segurança, dados e rollback.

3.3 Publicação no GitHub Pages

Esta página foi desenhada para publicação estática em docs/index.html.

  1. Acesse Settings > Pages no repositório.
  2. Em Build and deployment, selecione Deploy from a branch.
  3. Escolha a branch de publicação (normalmente main) e a pasta /docs.
  4. Salve e aguarde o deploy automático do GitHub Pages.

URL esperada: https://sistema2d.github.io/FrameCode-VibeWork/.

3.4 Início rápido

  1. Abra o repositório em uma IDE com IA.
  2. No prompt, mencione AGENTS.md e peça diretamente sua tarefa: Siga AGENTS.md e: <sua solicitação>.
  3. A IA deve ler os arquivos necessários, aplicar o fluxo de plano, implementar, validar e registrar changelog/wiki conforme o framework.
  4. Revise o resultado e publique as mudanças para atualização do GitHub Pages.
Resultado prático: o processo fica quase automático para humanos, mantendo governança e rastreabilidade técnica.