From 8f557b0581a6bae1df7d308c3367b4915554488f Mon Sep 17 00:00:00 2001 From: Jhony Cesar Date: Thu, 6 Aug 2026 16:34:22 -0400 Subject: [PATCH] docs: add project guidelines and documentation maintenance requirements for AI agents --- .agents/AGENTS.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .agents/AGENTS.md diff --git a/.agents/AGENTS.md b/.agents/AGENTS.md new file mode 100644 index 0000000..21ca71e --- /dev/null +++ b/.agents/AGENTS.md @@ -0,0 +1,9 @@ +# Diretrizes do Projeto - Gestão de Manutenção + +## Leitura Obrigatória da Documentação +- **Consulta Prévia**: Antes de planejar, pesquisar ou implementar qualquer alteração, a IA deve sempre consultar a documentação relevante contida no diretório [`documentacao/`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao) (como [`arquitetura_do_sistema.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao/arquitetura/arquitetura_do_sistema.md), [`fluxo_de_dados_e_sincronizacao.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao/fluxo_de_dados_e_sincronizacao.md), [`recursos_simulados_e_truncados.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao/recursos_simulados_e_truncados.md)) e no [`README.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/README.md). +- **Alinhamento Arquitetural**: Certifique-se de compreender os padrões arquiteturais offline-first, sincronização, modelos de dados e restrições descritas na documentação antes de propor ou alterar o código. + +## Atualização Pós-Modificação +- **Manutenção da Documentação**: Sempre que forem feitas modificações importantes no código (ex.: novas funcionalidades, refatoração de arquitetura, novos fluxos de sincronização, alterações em modelos de dados ou Room DAO/Database, adição de configurações), a IA deve obrigatoriamente atualizar os documentos correspondentes no diretório [`documentacao/`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/documentacao) ou no [`README.md`](file:///home/cesarjhony/dev/projects/gestao_de_manutencao/README.md). +- **Sincronia Código x Docs**: A documentação deve refletir com exatidão as mudanças realizadas para evitar inconsistências e garantir a evolução contínua do projeto.