1. Para que serve este guia
O eLabFTW (https://pdi.modal.org.br) é onde as pesquisas do Instituto Modal são registradas: a ficha do projeto, o plano, o caderno, as evidências e os produtos. As Diretrizes de Pesquisa Aplicada dizem o que registrar e por quê. Este guia mostra como fazer isso no eLabFTW, clique a clique, e o que escrever em cada campo.
O eLabFTW nasceu para laboratórios e não é intuitivo na primeira vez. Por isso cada etapa traz a tela real e um exemplo preenchido.
Exemplo hipotético. Todos os exemplos e telas deste guia vêm de um projeto inventado: "Assistente de IA para dúvidas sobre editais de fomento", conduzido pelas pesquisadoras fictícias Ana Lima e Bia Rocha, com a parceira fictícia Agência Exemplo de Fomento. O projeto foi criado no eLabFTW do Modal só para as capturas e apagado em seguida. Nenhum dado, pessoa ou organização dos exemplos é real.
2. Primeiro acesso
Endereço: https://pdi.modal.org.br. Use Firefox, Chrome ou Edge; o Safari não é suportado.
Conta: pesquisadores do Modal clicam em Cadastrar e usam o e-mail @modal.org.br; um administrador valida a conta. Parceiros e bolsistas externos pedem a conta pelo e-mail pesquisa@modal.org.br.
Segundo fator: é opcional. Quem quiser pode ativá-lo nas configurações da própria conta.
A interface está em português, com alguns textos em inglês ("Next step", "Last modified"). Algumas palavras vêm do uso em laboratórios:
| No eLabFTW | Quer dizer | Exemplos no Modal |
|---|---|---|
| Experimentos (menu do topo) | Registros de pesquisa, escritos ao longo do projeto | Plano de pesquisa, Registro de caderno, Desvio do plano, Relatório de marco |
| Recursos (menu do topo) | Fichas que se repetem e são citadas pelos registros | Projeto de pesquisa, Evidência, Produto |
| Modelo | O formulário pronto de cada tipo de registro, com campos, texto e lista de verificação | Modelo "Registro de caderno" |
| Etiqueta de situação | Em que pé está o registro; fica ao lado do tipo, no alto da página | Em planejamento, Em andamento, Concluído |
| Campos personalizados | Os campos de formulário de cada modelo | "Pesquisador-líder", "Sigilo" |
| Links | Ligações entre registros | O caderno ligado à ficha do projeto |
| Etapas | A lista de verificação do registro | "A proposta foi registrada no Comitê de PD&I" |
3. O mapa de um projeto
Tudo gira em torno da ficha do projeto. Os demais registros são ligados a ela, e é por essas ligações que o projeto fica rastreável.
| Registro | Menu do topo | Modelo | Quando | Quem escreve |
|---|---|---|---|---|
| Ficha do projeto | Recursos | Projeto de pesquisa | No início, uma vez | Pesquisador-líder |
| Plano de pesquisa | Experimentos | Plano de pesquisa | No início | Equipe, coordenada pelo líder |
| Registro de caderno | Experimentos | Registro de caderno | Sempre que algo muda o entendimento ou o rumo | Cada pessoa, as próprias entradas |
| Evidência | Recursos | Evidência | Quando um fato precisa ser comprovado | Quem tem a evidência |
| Desvio do plano | Experimentos | Desvio do plano | Quando pergunta, método, prazo ou equipe mudam | Pesquisador-líder |
| Relatório de marco | Experimentos | Relatório de marco | Ao fim de cada etapa | Pesquisador-líder |
| Produto | Recursos | Produto | Quando começa a redação de um resultado | Autores |
4. Como criar qualquer registro
O caminho é sempre o mesmo, para todos os tipos:
No menu do topo, abra Recursos (ficha, evidência, produto) ou Experimentos (plano, caderno, desvio, marco).
Clique no botão azul Criar, no canto superior direito. Abre a janela "Criar uma nova entrada" (Figura 1), já com o tipo certo marcado.
Em Digite um título, escreva o título do registro.
Clique em Começar a partir de um modelo. Aparece a lista de modelos.
Se a lista vier vazia, clique em Escopo e escolha Equipe: os modelos do Modal pertencem à administração e não aparecem no escopo "Eu".
Na linha do modelo certo, clique no botão azul com o ícone de documento, à direita. O registro é criado e abre em edição.
Não use "Criar ... sem utilizar um modelo". Sem o modelo, o registro nasce sem campos, sem seções e sem lista de verificação.
4.1. A página de edição
O registro abre em edição (Figura 2). De cima para baixo:
Topo: o número do registro, o tipo, a etiqueta de situação e o título.
Barra de botões: seta para voltar à lista, disquete azul para salvar, olho para salvar e visualizar, seta para baixo para exportar e cadeado para bloquear.
Texto principal: o texto do modelo, com as seções a preencher. Substitua as orientações em itálico pelo seu texto.
Campos personalizados: o formulário do modelo.
Mais abaixo: Arquivos anexados, Etapas (lista de verificação), Links e Permissões.
Atenção ao salvar. Os campos personalizados se gravam sozinhos quando você sai do campo. O texto principal só é gravado quando você clica no disquete azul; confira a frase "Salvo pela última vez" logo abaixo do texto. Se tentar sair da página com texto não salvo, o navegador pergunta se quer mesmo sair.
Não mexa no formulário. Ao lado de cada campo personalizado há ícones de lápis, cadeado e lixeira: eles mudam o próprio formulário (renomeiam, travam ou apagam o campo). Não use esses ícones nem os botões "Adicionar campo" e "Carregar campos". Para mudar um modelo, escreva para pesquisa@modal.org.br.
Para mudar a situação, clique na etiqueta de situação no alto (por exemplo, "EM PLANEJAMENTO"): ela vira uma lista; escolha a nova situação.
5. Abrir o projeto
5.1. Peça o grupo do projeto
Escreva para pesquisa@modal.org.br com o nome do projeto e as pessoas da equipe. Um administrador cria o grupo do projeto, que é quem terá acesso aos registros.
5.2. Crie a ficha
Siga a seção 4 em Recursos, com o modelo Projeto de pesquisa. Quem cria a ficha deve ser o pesquisador-líder: o dono da ficha é quem recebe os lembretes do sistema.
| Campo | O que pôr | Exemplo hipotético |
|---|---|---|
| Título | Nome do projeto, curto e descritivo | Assistente de IA para dúvidas sobre editais de fomento |
| Vínculo | Natureza do projeto | Projeto com parceiro |
| Início e Término previsto | Datas do projeto | 01/03/2027 e 30/11/2027 |
| Proposta no Comitê de PD&I | Link da proposta aprovada | Link do registro da proposta |
| Pasta do projeto | Link da pasta de arquivos do projeto | Link da pasta no drive do Modal |
| Dias sem caderno para lembrete | Depois de quantos dias sem entrada de caderno o líder recebe um lembrete. Vazio vale 30 | 21 |
| Pesquisador-líder | Nome de quem coordena (o dono da ficha) | Ana Lima |
| Pesquisadores | Nome e parte que conduz | Ana Lima — avaliação do assistente; Bia Rocha — base de editais e testes |
| Colaboradores e orientador | Quem contribui sem ser da equipe | Prof. Caio Melo (orientador) |
| Parceiro | Organização envolvida, se houver | Agência Exemplo de Fomento |
No texto principal, preencha o Resumo, os Combinados da equipe (ou "estão no plano de pesquisa") e os Registros fora daqui (repositórios, planilhas, pastas). Salve no disquete azul.
Exemplo hipotético — Resumo. Pesquisadores perdem horas lendo editais de fomento para saber se podem concorrer. O projeto pergunta se um assistente de IA, que responde citando o trecho do edital, acerta ao menos 90% das perguntas de elegibilidade feitas por pesquisadores. Contexto: 30 editais públicos e perguntas reais de uma agência parceira.
A ficha nasce em "Em planejamento". Mude para "Em andamento" quando o trabalho começar.
5.3. Restrinja o acesso
A ficha nasce visível para todos os pesquisadores do Modal ("Apenas membros da equipe"). Em projeto com parceiro isso não serve: a equipe do eLabFTW reúne todos os pesquisadores do Instituto. Ajuste em cada registro do projeto:
Desça até Permissões, no fim da página de edição.
Ao lado de Visibilidade, clique no +. Abre a janela "Selecionar quem pode ver esta entrada" (Figura 4).
Em Base, escolha Apenas proprietário e administradores.
Em + Grupos de usuários, digite o nome do grupo do projeto e escolha-o na lista.
Clique em Aplicar a Leitura e Escrita e confirme: a mesma regra passa a valer para quem pode ver e para quem pode editar. Se só quiser mudar quem vê, clique em Salvar.
Confira em Permissões: "Visibilidade" e "Pode escrever" devem mostrar a base escolhida e o grupo do projeto.
6. O plano de pesquisa
Siga a seção 4 em Experimentos, com o modelo Plano de pesquisa. O modelo traz as dez seções do plano, os campos e a lista de verificação "Antes de começar". O plano tem de duas a três páginas.
| Campo | O que pôr | Exemplo hipotético |
|---|---|---|
| Vínculo | O mesmo da ficha | Projeto com parceiro |
| Abordagem metodológica | O método principal (Diretrizes, seção 5) | Design Science Research |
| Início previsto e Término previsto | Período do plano | 01/03/2027 e 30/11/2027 |
| Plano retrospectivo | Marque só se o plano foi escrito depois de o trabalho acontecer | Desmarcado |
| Proposta no Comitê de PD&I | Link da proposta | Link do registro da proposta |
As seções do texto principal, com um trecho de exemplo de cada uma:
| Seção | O que escrever | Exemplo hipotético |
|---|---|---|
| 1. Combinados da equipe | Líder, quem faz o quê, frequência das conversas, como as decisões são registradas, previsão de autoria | Líder: Ana. Ana avalia o assistente; Bia monta a base de editais e os testes. Conversas quinzenais às terças. Decisões viram entrada de caderno. Autoria prevista: Ana e Bia. |
| 2. Problema e pergunta | A situação real e uma pergunta principal | Um assistente de IA que cita o trecho do edital acerta ao menos 90% das perguntas de elegibilidade? |
| 3. Por que importa | Para quem o resultado serve | Pesquisadores economizam tempo na triagem de editais; a agência reduz dúvidas repetidas. |
| 4. O que já se sabe | Três a cinco referências, inclusive uma com resultado contrário | Estudos de recuperação com citação da fonte mostram ganho de precisão; há relatos de respostas confiantes e erradas em textos normativos longos. |
| 5. Objetivos | Geral e específicos | Construir e avaliar o assistente; montar 300 perguntas com resposta conferida; medir acerto e tipos de erro. |
| 6. Método | Abordagem, contexto, etapas, como avaliar | Construir o assistente e avaliá-lo com perguntas reais; duas pessoas conferem cada resposta às cegas. |
| 7. Plano de evidências | O que será registrado, onde fica e para que serve | Planilha de avaliação (pasta do projeto, mostra a taxa de acerto); registros de execução (repositório, mostram o que o modelo recebeu e respondeu). |
| 8. Produtos e marcos | O que será entregue e quando | Marco 1: base de editais e perguntas (junho de 2027). Relatório RT-Modal (novembro de 2027). |
| 9. Cuidados | Participantes, dados pessoais, sigilo do parceiro, propriedade intelectual, uso de IA | Perguntas podem conter dados pessoais: anonimizar antes de usar. Perguntas da agência são restritas ao parceiro. Uso de IA: é o objeto do estudo e será declarado. |
| 10. Referências | No formato ABNT NBR 6023 | — |
Salve no disquete azul. Em Etapas, marque cada item da lista de verificação quando ele for cumprido (Figura 6). A conferência mensal do sistema aponta os itens mínimos ainda desmarcados (seção 11).
Por fim, ligue o plano à ficha (seção 8) e ajuste as permissões (seção 5.3).
7. Durante o projeto
7.1. Entrada de caderno
O caderno é a memória do projeto. Registre o que mudou o entendimento ou o rumo: uma decisão, uma avaliação, uma falha, uma surpresa. Trabalho de rotina não entra; resultado negativo entra com o mesmo cuidado.
Siga a seção 4 em Experimentos, com o modelo Registro de caderno:
Título:
AAAA-MM-DD — assunto.Tipo de registro (campo): Decisão, Avaliação, Falha, Surpresa ou Outro.
O que aconteceu: o fato, com data, números e fonte.
O que se aprendeu ou o que muda: a interpretação ou a decisão.
Links: ligue a entrada à ficha do projeto e às evidências que a sustentam (seção 8).
A entrada nasce "Em andamento"; cada pessoa escreve as próprias entradas, e o eLabFTW registra autor, data e todas as alterações. A Figura 7 mostra a entrada do exemplo no modo de visualização (botão do olho), com o tipo e as duas ligações.
7.2. Evidência
Evidência é o que comprova um fato citado no caderno ou no relatório: uma planilha, um registro de sistema, uma mensagem, uma entrevista. Ela é citada pelo número (E01, E02...).
Siga a seção 4 em Recursos, com o modelo Evidência.
| Campo | O que pôr | Exemplo hipotético |
|---|---|---|
| Título | Uma descrição curta. Não precisa pôr o número: o sistema numera sozinho (seção 11) | Avaliação das respostas do assistente, junho de 2027 |
| Tipo | A natureza da evidência | Medição ou dado |
| Data da evidência | Quando o fato aconteceu, não quando foi registrado | 30/06/2027 |
| Localização | Link para onde a evidência já está | Link da planilha de avaliação |
| Sigilo | Público, Interno ou Restrito ao parceiro. Se ficar vazio, o sistema preenche "Restrito ao parceiro" | Restrito ao parceiro |
| Descrição (texto principal) | Uma ou duas linhas: o que é e o que mostra | Planilha com as 300 perguntas, a resposta do assistente e a conferência de duas pessoas; mostra 86% de acerto e os erros concentrados em editais com anexos. |
Aponte para onde a evidência já está; anexe uma cópia só do que pode desaparecer (conversas, painéis, páginas externas): arraste o arquivo para a área tracejada de Arquivos anexados (Figura 9), até 100 MB por arquivo. Evidência sem localização e sem anexo aparece como pendência na conferência mensal.
Ligue a evidência à ficha do projeto (seção 8). Sem essa ligação ela não recebe número.
Exemplo hipotético — numeração. Bia cria a evidência "Avaliação das respostas do assistente, junho de 2027" e a liga à ficha. O projeto ainda não tem evidências numeradas. Na conferência da hora seguinte o título vira "E01 · Avaliação das respostas do assistente, junho de 2027", e Bia recebe um e-mail com o número para citar no caderno.
7.3. Desvio do plano
Toda mudança de pergunta, método, contexto, produto, cronograma ou equipe vira um registro de desvio. Desvio declarado é sinal de rigor, não de falha.
Siga a seção 4 em Experimentos, com o modelo Desvio do plano: escolha o Aspecto alterado e escreva o que mudou, por quê e o impacto. Ligue à ficha.
Exemplo hipotético — Desvio do plano. Aspecto alterado: Método. O que mudou: o plano previa usar só o texto dos editais; agora os anexos escaneados passam por reconhecimento de texto antes. Por quê: os erros se concentravam nesses anexos (E01). Impacto: o marco 1 passa de junho para julho.
7.4. Relatório de marco
Ao fim de cada etapa relevante, uma página que resume o caderno do período, sem acrescentar registro novo. Para bolsistas, é o relatório parcial.
Siga a seção 4 em Experimentos, com o modelo Relatório de marco: preencha Início do período, Fim do período e Situação (No prazo, Com atraso, Com mudança de rumo), e escreva o que foi feito, o que se aprendeu, os desvios, os próximos passos e as decisões necessárias. Marque as etapas do período.
Exemplo hipotético — Relatório de marco. Período: 01/03 a 31/07/2027. Situação: Com mudança de rumo. O que se aprendeu: com os anexos tratados, o acerto subiu de 86% para 93% (E02); o tempo médio de resposta ficou em 4 segundos. Decisões necessárias: a agência parceira precisa autorizar o uso das perguntas de 2026.
7.5. Situação dos registros
Mantenha a situação de cada registro atualizada pela etiqueta no alto da página (seção 4.1). Quando muda a situação da ficha, do plano, de um marco, de um desvio ou de um produto, a equipe do projeto recebe um e-mail (seção 11).
8. Ligar registros
As ligações tornam o projeto rastreável: da ficha se chega ao plano, ao caderno, às evidências e aos produtos. Na página de edição de qualquer registro, desça até Links:
Para ligar uma ficha, evidência ou produto, use Links de recursos; para ligar um plano, caderno, desvio ou marco, use Links de experimentos.
Digite parte do título (por exemplo, a primeira palavra do nome do projeto) e espere a lista de sugestões (Figura 10).
Clique na sugestão certa e depois no botão azul Adicionar. O número entre parênteses aumenta.
A ligação vale feita de qualquer um dos dois lados. Ligue sempre:
cada registro à ficha do projeto;
cada entrada de caderno às evidências que a sustentam;
cada produto à ficha do projeto.
9. Permissões e sigilo
Ajuste a visibilidade de cada registro como na seção 5.3: base "Apenas proprietário e administradores" mais o grupo do projeto.
Informação restrita ao parceiro fica em evidência marcada como "Restrito ao parceiro" e não vai para a versão pública de nenhum relatório.
Não registre dados pessoais além do necessário; anonimize antes de anexar.
10. Encerrar e comunicar
10.1. Produto
Siga a seção 4 em Recursos, com o modelo Produto, assim que a redação de um resultado começar. Ligue à ficha.
| Campo | O que pôr | Exemplo hipotético |
|---|---|---|
| Tipo de produto | Relatório técnico, artigo, trabalho acadêmico etc. | Relatório técnico (série RT-Modal) |
| Identificador | Número na série, dado na revisão editorial | RT-Modal 2027-NN |
| DOI ou endereço | Preenchido pelo sistema no depósito no Zenodo, ou à mão para outros veículos | (deixe vazio) |
| Situação do produto | Em redação, Em revisão, Submetido, Publicado | Em revisão |
| Autores | Separados por barra vertical; cada um "Sobrenome, Nome; vínculo; ORCID" (ORCID opcional) | Lima, Ana; Instituto Modal | Rocha, Bia; Instituto Modal |
| Resumo | O resumo como vai aparecer no Zenodo | Avalia um assistente de IA que responde dúvidas sobre editais de fomento... |
| Palavras-chave | Separadas por ponto e vírgula | inteligência artificial; editais de fomento; recuperação de informação |
| Depositar no Zenodo | Marque só depois da revisão editorial, com o PDF final anexado | (desmarcado até a revisão) |
No texto principal: a referência (como citar, ABNT NBR 6023) e as observações (veículo, prazos, revisões). Em Etapas, cumpra a lista "Antes de publicar".
10.2. Depósito no Zenodo
Para relatórios da série RT-Modal e outros produtos depositados no Zenodo:
Anexe ao Produto o PDF final, já revisado (área de Arquivos anexados).
Preencha Autores, Resumo e Palavras-chave.
Marque Depositar no Zenodo.
Em até 15 minutos o sistema cria um rascunho no Zenodo do Instituto, com o PDF, a licença CC BY 4.0 e a comunidade do Instituto, e grava o DOI reservado no Produto. A conta do Instituto recebe o link do rascunho para conferir e publicar; você recebe uma cópia. Nada é publicado sozinho: um DOI publicado não se desfaz. Se faltar alguma informação, você recebe um e-mail dizendo o quê.
10.3. Exportar
No botão de exportar (seta para baixo, na barra de botões), escolha o formato (Figura 12): Arquivo PDF para o apêndice de um relatório, ou Arquivo ELN, um formato aberto, para arquivo.
10.4. Encerrar o projeto
Marque as etapas finais da ficha, mude a situação para "Concluído" e bloqueie os registros principais (cadeado, na barra de botões), para que não sejam mais alterados.
11. O que o sistema faz sozinho
O eLabFTW do Modal conversa com um serviço de automação que confere os registros e manda e-mails. Nenhuma dessas rotinas publica nada; só o depósito no Zenodo grava algo fora do Modal, e sempre como rascunho.
| Rotina | Quando | Quem recebe | O que fazer |
|---|---|---|---|
| E-mail de mudança de situação | Quando muda a situação da ficha, do plano, de um marco, de um desvio ou de um produto | A equipe do projeto | Nada; é aviso |
| Numeração das evidências | A cada hora, para evidências ligadas a uma ficha e paradas há 15 minutos | Quem criou a evidência | Citar o número recebido |
| Sigilo padrão | Junto com a numeração, se o sigilo estiver vazio | Quem criou a evidência | Ajustar se não for o caso |
| Lembrete de caderno parado | Todo dia às 9h, quando o caderno passa do prazo da ficha (padrão: 30 dias); repete a cada 7 dias | O dono da ficha (o líder) | Registrar o que aconteceu e ligar à ficha |
| Conferência dos registros | Todo dia 1º, às 9h | O líder, com a lista de pendências; pesquisa@modal.org.br, um consolidado | Corrigir as pendências apontadas |
| Pré-checagem do relatório anual | Em 1º de dezembro | O líder | Corrigir até 15 de janeiro |
| Depósito no Zenodo | A cada 15 minutos, para produtos marcados | A conta do Instituto; cópia ao autor | Conferir e publicar no Zenodo |
A conferência mensal aponta: projeto sem plano ligado; itens mínimos da lista do plano desmarcados; evidência sem localização e sem anexo; entrada de caderno sem evidência; produto publicado sem DOI; término previsto vencido; e qualquer registro sem ligação com a ficha.
12. Perguntas frequentes
A lista de modelos veio vazia. Na janela "Criar uma nova entrada", clique em Escopo e escolha Equipe.
Escrevi o texto e ele sumiu. O texto principal só é gravado no disquete azul. Os campos personalizados se gravam sozinhos.
Criei a evidência e ela não ganhou número. Confira se ela está ligada a uma única ficha de projeto e espere até uma hora. Se estiver ligada a duas fichas ou a nenhuma, você recebe um e-mail explicando.
Recebi o lembrete de caderno, mas o projeto está andando. O lembrete conta só entradas de caderno ligadas à ficha. Ligue as entradas que já escreveu. Se o ritmo do projeto for mais lento, aumente o campo "Dias sem caderno para lembrete" da ficha.
Apaguei um campo do formulário sem querer. Escreva para pesquisa@modal.org.br; o campo é restaurado a partir do modelo.
Os campos obrigatórios não impediram salvar. É assim no eLabFTW; confira antes de concluir.
Errei um registro. Perdi o histórico? Não. Cada alteração gera uma revisão; o histórico fica guardado. Escreva com cuidado o que for publicado.
Posso usar IA para redigir? Pode, e declare no próprio registro (Diretrizes, seção 10.4).
Marquei "Depositar no Zenodo" e nada aconteceu. Confira se o PDF está anexado e se Autores e Resumo estão preenchidos; o e-mail de falta de informação diz o que corrigir. Se o Produto já tiver DOI, o depósito não é feito.
13. Ajuda
Dúvidas e problemas: pesquisa@modal.org.br.