Know é a documentação viva de cada sistema — escrita uma vez, consultada por humanos e pela IA toda vez que precisam entender o que existe antes de agir.
O que é o Know
Lista todas as telas, endpoints, tabelas e regras de negócio — o que existe, onde fica e como foi construído. Um arquivo por feature.
Quando alguém entra no projeto pela primeira vez, o know responde "o que isso faz?" antes de precisar abrir qualquer linha de código.
Decisões de arquitetura, integrações externas, padrões de código e regras de negócio — registrados para não se perderem com o tempo.
A IA que nos ajuda a construir lê o know antes de agir. Ela sabe o que já existe, quais features se conectam, e o que não deve tocar.
Para quem serve
"Quero saber o que foi entregue, o que cada tela faz e quem é responsável por cada módulo."
"Entrei no projeto hoje. Preciso saber o que existe, como está estruturado e onde fica cada coisa antes de mexer."
"Antes de qualquer ação, leio o know. Sei o que já existe, o que não devo duplicar e quais features se conectam."
Como funciona
Uma funcionalidade é criada, alterada ou descoberta no código. Ela recebe um arquivo .md estruturado com slug único.
Título, o que faz, endpoints, tabelas, regras de negócio, gatilhos de execução, dependências e quem usa. Tudo num formato padrão.
Qualquer agente carrega o know como contexto. Ele sabe o que existe, como está conectado e o que pode causar impacto antes de mexer em qualquer coisa.
Dev, gestor e cliente têm a mesma fonte de verdade. Quando o sistema muda, o know é atualizado junto — sem documentação parada no tempo.
Estrutura do Know
Cada projeto tem seu próprio repositório {slug}-know seguindo a mesma estrutura. O que é obrigatório existe em todo projeto. O que é opcional é ativado conforme a necessidade.
Projetos documentados