USO INSTITUCIONAL

Diretrizes de Pesquisa Aplicada

Como planejar, conduzir e comunicar pesquisas no Instituto Modal

Versão1.1
AutorDiretoria de Pesquisa e Inovação
Data2026-11-20
Identificador2026DPESQ1119.Modal.v11
Statusaprovado
Imagem de capa

Identificação Institucional

Instituto Modal de Ciência, Tecnologia e Inovação

Diretoria

  • Welington de Souza Evangelista — Diretor Presidente

  • Bruno Carvalho Castro Souza — Diretor de Governança e Diretor de Pesquisa e Inovação

  • Neilsen Seixas — Diretor de Negócios

  • Larissa Mendes — Diretora Jurídica e Presidente do Conselho de Administração

Revisões

VersãoDataAlterações / ComentáriosRevisor(es)
0.119/11/2026Criação do documento.Bruno Souza
0.219/11/2026Papéis da equipe, listas de verificação, exemplos, linguagem e referências com link.Bruno Souza
0.319/11/2026eLabFTW como ferramenta padrão de registro; Apêndice A com o guia de uso.Bruno Souza
0.419/11/2026Estrutura de política; formato do relatório técnico flexível.Bruno Souza
0.519/11/2026Capa institucional e página de identificação no perfil de política; legendas ABNT automáticas. Rascunho para aprovação do Diretor de Pesquisa e Inovação.Bruno Souza
1.019/11/2026Aprovação pelo Diretor de Pesquisa e Inovação.Bruno Souza
1.120/11/2026Apêndice A resumido, com remissão ao Guia de Uso do eLabFTW (segundo fator opcional, numeração automática das evidências, rotinas automáticas); submissão pelo formulário do site, com criação automática da ficha, do grupo e da conta do proponente; depósito no Zenodo preparado a partir do eLabFTW; o pesquisador-líder é o dono da ficha; prazo do lembrete de caderno ajustável na ficha. Aprovação pelo Diretor de Pesquisa e Inovação.Bruno Souza

1. Apresentação

1.1. Propósito

Estas diretrizes dizem o que um pesquisador do Instituto Modal precisa fazer, no mínimo, para que o resultado da sua pesquisa seja confiável e possa ser publicado. Valem para qualquer projeto de pesquisa, desenvolvimento ou inovação reconhecido pelo Instituto, de software ou não.

Elas detalham a Política de Pesquisa, Desenvolvimento e Inovação do Instituto, como prevê o item 10 daquele documento. Lá estão a governança e a gestão: quem aprova, como se formaliza, como se acompanha, como se protege a propriedade intelectual. Aqui está o rigor da pesquisa: como escolher o método, registrar evidências, declarar limites e comunicar resultados. Nada do que já está lá se repete aqui; quando o assunto é de governança, o texto apenas remete a ela.

1.2. Como usar este documento

Não é preciso ler tudo de uma vez. Cada momento da pesquisa tem as suas seções:

MomentoLeia
Ao montar a equipe e começarSeções 2 (papéis), 3 (ciclo da pesquisa), 5 (método) e 10 (ética, dados e propriedade intelectual)
Durante o projetoSeções 6 (evidências) e 12 (onde registrar), e o Apêndice A (guia do eLabFTW)
Ao escrever e publicarSeções 7 (produtos), 8 (série de relatórios técnicos), 9 (pesquisa retrospectiva) e 11 (linguagem)
Ao fim de cada momentoSeção 4 (listas de verificação)

Cada exigência está marcada como mínimo, obrigatória para todo projeto, ou desejável, a adotar conforme o porte do projeto. Os exemplos vêm de dois projetos fictícios, um de software e outro fora dele (seção 3). Os modelos estão no eLabFTW e, para as exceções, em Markdown (seção 14). Dúvidas: pesquisa@modal.org.br.

1.3. Boas práticas

Na prática, quase todos os pesquisadores do Modal também trabalham em projetos com prazo, e esses projetos têm prioridade. Por isso as diretrizes partem de compromissos que economizam tempo:

  • O mínimo é pequeno e obrigatório; o resto é desejável. Projeto pequeno cumpre o mínimo. Projeto grande, com fomento externo ou com intenção de publicação em periódico, avança no desejável.

  • Registrar onde o trabalho já acontece. Commits, issues, atas, planilhas e mensagens são evidências. O pesquisador aponta para elas; não copia nem reescreve.

  • Registrar no momento. Uma entrada curta escrita no dia vale mais que uma reconstrução de memória meses depois.

  • Cada documento do início alimenta o resultado final. O plano vira a introdução e o método do relatório; o caderno vira os resultados e as limitações. Nada é preenchido duas vezes.

  • Ligar tudo à ficha do projeto. Plano, caderno, evidências e produtos ligados à ficha tornam o projeto rastreável para a equipe, para o Comitê e para quem vier depois.

  • Registrar também o que não funcionou e declarar o uso de IA, os limites do resultado e o sigilo devido ao parceiro desde o início.

Plano, caderno, evidências e produtos são registrados no eLabFTW do Modal (https://pdi.modal.org.br), a ferramenta padrão de registro de pesquisa do Instituto (seção 12). O Guia de Uso do eLabFTW explica como usá-lo, passo a passo (Apêndice A).

2. Papéis e trabalho em equipe

2.1. Papéis

A maioria das pesquisas do Modal é feita em equipe. Os papéis abaixo organizam o trabalho; não criam hierarquia entre pesquisadores.

PapelQuem éResponsabilidades
Pesquisador-líderUm dos pesquisadores, escolhido pela equipePonto focal do projeto. Mantém o plano atualizado, cuida para que o caderno seja alimentado, convoca as conversas de equipe, representa o projeto perante o Comitê de PD&I e o parceiro, coordena a redação dos produtos.
PesquisadorCada integrante da equipe de pesquisaExecuta a sua parte, registra no caderno o que fez e aprendeu, contribui para análise e redação, revisa os produtos antes do envio.
ColaboradorQuem apoia sem conduzir a pesquisa (desenvolvedor do projeto, especialista consultado, participante de oficina)Contribui com trabalho, dados ou opinião. É reconhecido em agradecimentos ou, se a contribuição for substancial, como autor (seção 10.3).
OrientadorQuando houver bolsista ou trabalho acadêmicoAcompanha o método e a qualidade, revisa plano e relatórios, dá parecer nos relatórios do bolsista.
ParceiroOrganização envolvida no projeto, quando houverDefine com o Modal sigilo, uso de dados e publicação no instrumento de parceria (Política, item 6.1). Pode ter um representante na equipe.
Comitê de PD&IInstância que exerce as funções de NIT (Política, itens 5 e 6)Avalia a proposta e o mérito científico, acompanha marcos quando o porte exigir, faz a revisão editorial da série de relatórios técnicos e se manifesta sobre propriedade intelectual e divulgação.

Em pesquisa individual, o pesquisador acumula os papéis de líder e de pesquisador.

2.2. Combinados da equipe

No início do projeto, a equipe registra no plano (seção 1 do modelo 01) cinco combinados:

  1. Quem é o pesquisador-líder.

  2. Quem faz o quê, em linhas gerais.

  3. Como e com que frequência a equipe conversa sobre a pesquisa (ex.: 30 minutos a cada duas semanas, ou um ponto fixo na reunião do projeto).

  4. Como as decisões de pesquisa são registradas: toda decisão que muda pergunta, método ou produto vira uma entrada no caderno, assinada por quem a registrou.

  5. Uma previsão inicial de autoria dos produtos, revisável ao longo do projeto.

Divergências sobre método, resultados ou autoria são resolvidas primeiro na equipe. Se persistirem, o pesquisador-líder leva o assunto ao Comitê de PD&I.

3. O ciclo da pesquisa: antes, durante e depois

O ciclo tem três momentos. A ordem é a natural, mas pode ser ajustada à pesquisa: um estudo exploratório pode refazer o plano várias vezes; um estudo retrospectivo (seção 9) monta o plano depois do fato.

Os exemplos das tabelas vêm de dois projetos fictícios, para mostrar que as mesmas exigências valem dentro e fora do software:

  • Projeto A: uso de agentes de IA no desenvolvimento de sistemas de uma empresa parceira.

  • Projeto B: modelo de previsão de safra para uma cooperativa agrícola, a partir de dados de satélite.

3.1. Antes

O que fazerNívelExemplo
Registrar a proposta no Comitê de PD&I, pelo formulário de submissão do site (Política, Anexo III). Aprovada a proposta, a ficha do projeto, o grupo e a conta do proponente no eLabFTW são criados automaticamente.MínimoO líder do Projeto B envia o formulário de submissão com problema, equipe e resultados esperados.
Escrever o plano de pesquisa (modelo 01), com os combinados da equipe.MínimoProjeto A: "Pergunta: que práticas tornam o desenvolvimento com agentes de IA verificável e repetível? Abordagem: Design Science, avaliada por estudo de caso na empresa parceira."
Montar o plano de evidências (seção 7 do plano).MínimoProjeto A: histórico de commits e issues dos sistemas, medições de uso das ferramentas, registro dos defeitos encontrados em homologação.
Verificar os cuidados de ética, dados, sigilo e propriedade intelectual (seção 9 do plano).MínimoProjeto B: os dados de produtividade por produtor são dados pessoais; base legal registrada e anonimização prevista antes da análise.
Abrir o projeto no eLabFTW: ficha do projeto, grupo da equipe e plano ligado à ficha (seção 12 e Apêndice A).MínimoFicha "Previsão de safra por satélite" criada, com o grupo do Projeto B e o plano ligado a ela.
Pedir a um colega de fora do projeto que leia o plano.DesejávelUm pesquisador de outra equipe aponta que o Projeto B não diz como a previsão será comparada com a safra real.
Detalhar o protocolo do método.DesejávelProjeto B descreve as variáveis, o período de treino e o critério de erro aceitável.

3.2. Durante

O que fazerNívelExemplo
Registrar no caderno (modelo 02) decisões, avaliações, falhas, surpresas e desvios.MínimoProjeto A: "2026-07-14. A orientação de testes foi usada em 3 de 20 situações previstas, e os testes saíram no padrão mesmo sem ela. Hipótese: o padrão já está no contexto do projeto. Evidência E12."
Registrar cada evidência no eLabFTW e ligá-la às entradas que ela sustenta.Mínimo"E12 · Medição de uso de julho": tipo medição, data, link para a planilha e cópia anexada ao registro.
Registrar resultados negativos com o mesmo cuidado dos positivos.MínimoProjeto B: "O índice de vegetação sozinho não previu a quebra de safra de 2025. Vamos testar a inclusão de dados de chuva."
Fazer um relatório de marco (modelo 03) a cada etapa relevante.Desejável; mínimo para bolsistasProjeto B entrega um relatório de uma página ao fim da fase de coleta de dados.
Conversar periodicamente com o Comitê de PD&I.Desejável para projetos grandesProjeto A apresenta os resultados parciais ao Comitê no fim do semestre.

3.3. Depois

O que fazerNívelExemplo
Produzir pelo menos um produto de comunicação (seção 7), com as declarações (seção 10).MínimoProjeto A publica o relatório técnico RT-Modal 2026-01.
Enviar ao Comitê de PD&I o insumo para o relatório anual (Política, item 8).MínimoUm parágrafo com resultados, produtos e próximos passos.
Pedir ao Comitê a avaliação de propriedade intelectual, quando houver ativo protegível.Mínimo, quando aplicávelProjeto B gerou um modelo de previsão; o Comitê avalia registro e licenciamento antes da publicação.
Publicar na série de relatórios técnicos, com DOI.DesejávelRelatório depositado no Zenodo após a revisão editorial.
Publicar artigo, dados ou pacote de reprodução.DesejávelProjeto B publica os dados anonimizados e o código de análise.
Registrar lições aprendidas para uso do Instituto.DesejávelProjeto A registra que a medição automatizada de uso deveria ter começado no primeiro mês.

4. Listas de verificação do pesquisador

Use estas listas ao fim de cada momento. Os itens sem marca são mínimos; os marcados com (desejável) dependem do porte do projeto.

4.1. Antes de começar

  • [ ] A proposta foi registrada no Comitê de PD&I.

  • [ ] O plano tem pergunta, método, plano de evidências e produtos.

  • [ ] O plano registra os combinados da equipe, inclusive quem é o pesquisador-líder.

  • [ ] Os cuidados de ética, dados, sigilo e propriedade intelectual foram verificados e registrados.

  • [ ] Se há pessoas como participantes, a necessidade de Comitê de Ética foi verificada e a conclusão está registrada no projeto.

  • [ ] A ficha do projeto foi criada no eLabFTW, e toda a equipe está no grupo do projeto.

  • [ ] (desejável) Um colega de fora do projeto leu o plano.

4.2. Durante o projeto

  • [ ] O caderno recebe entradas quando algo muda o entendimento ou o rumo.

  • [ ] Cada entrada diz quem a escreveu e aponta suas evidências.

  • [ ] Os desvios do plano estão registrados, com o motivo.

  • [ ] As evidências que podem desaparecer foram anexadas ao registro da evidência.

  • [ ] Os resultados negativos estão registrados.

  • [ ] (desejável) Os relatórios de marco foram feitos; para bolsistas, os relatórios parciais.

4.3. Antes de publicar

  • [ ] Cada conclusão importante cita a evidência ou a referência que a sustenta.

  • [ ] O texto diz onde o resultado se aplica e onde não se aplica.

  • [ ] As ameaças à validade e as limitações estão declaradas.

  • [ ] As declarações estão completas: autoria, uso de IA, conflito de interesses, financiamento e dados.

  • [ ] Não há dado pessoal identificável nem informação sigilosa de parceiro no texto público.

  • [ ] Todos os autores revisaram e aprovaram a versão final.

  • [ ] O Comitê de PD&I fez a revisão editorial (série RT-Modal) ou se manifestou sobre sigilo e propriedade intelectual (outros veículos).

  • [ ] O insumo para o relatório anual foi enviado.

5. Escolha do método

O método decorre da pergunta, e não o contrário. O plano declara qual abordagem a pesquisa adota e por quê. Não é preciso usar um método único; combinações são comuns e legítimas, desde que declaradas.

Quando a pergunta é...Abordagem usualReferência de partida
Como construir algo novo que resolva um problema, e se funcionaDesign Science ResearchHevner et al. (2004); Peffers et al. (2007); Wieringa (2014)
Como algo acontece num contexto real, que não se controlaEstudo de casoYin (2015); Runeson e Höst (2009), para engenharia de software
Como melhorar uma prática da qual o pesquisador participaPesquisa-açãoStaron (2020)
Se uma intervenção causa um efeito, com controle das variáveisExperimento ou quase-experimentoWohlin et al. (2012)
O que um grupo de pessoas pensa ou fazQuestionário ou entrevistasConforme a área
O que já se sabe sobre um temaRevisão de literatura (narrativa, sistemática ou de escopo)Kitchenham, Budgen e Brereton (2015)
Se algo é tecnicamente viávelDesenvolvimento experimental, prova de conceito, protótipoManual de Frascati (OECD, 2015)
O que documentos ou registros revelamPesquisa documentalConforme a área

Dados quantitativos em estudos de caso e em Design Science servem para ilustrar e demonstrar o resultado, não para generalizar estatisticamente. Quando houver números, o texto diz claramente qual é o seu papel.

Padrões de avaliação por método. Em engenharia de software, os ACM SIGSOFT Empirical Standards (Ralph et al., 2020) trazem, para cada método, a lista do que é essencial, desejável e extraordinário num estudo, além das críticas que um revisor não deve fazer. Recomenda-se usá-los como lista de verificação. Em outras áreas, use o padrão equivalente da área, quando existir, e registre a escolha no plano.

6. Evidências e rastreabilidade

Uma afirmação no relatório final é confiável quando é possível chegar à evidência que a sustenta. Para isso:

  • Mínimo: cada evidência é registrada uma vez, com identificador curto (E01, E02...), descrição de uma linha e localização (link, caminho ou referência), e ligada aos registros que ela sustenta. O relatório cita as evidências pelo identificador. No eLabFTW, o identificador é dado automaticamente às evidências ligadas à ficha do projeto.

  • Mínimo: evidências que podem desaparecer (conversas, painéis, páginas externas) são preservadas em cópia, anexadas ao registro da evidência, respeitado o sigilo.

  • Desejável: mais de uma fonte para cada conclusão importante (triangulação). Por exemplo: registro do sistema, medição e depoimento da equipe.

  • Desejável: um apêndice de rastreabilidade no relatório, ligando conclusões às evidências.

7. Produtos e o que cada um exige

O conteúdo mínimo das seções 3 a 6 vale para todos. Cada produto acrescenta exigências próprias:

ProdutoExigências próprias
Relatório técnico da série do ModalEstrutura do modelo 04, conforme a ABNT NBR 10719, em qualquer ferramenta de edição (seção 8). Revisão editorial do Comitê de PD&I. Número na série e DOI.
Artigo em periódico ou eventoNormas do veículo. Declarações exigidas pelo veículo (uso de IA, conflito de interesses, dados). Verificar sigilo e propriedade intelectual com o Comitê antes da submissão.
Trabalho acadêmico (graduação, especialização, mestrado, doutorado)Normas da instituição de ensino e do orientador. Instrumento entre o Modal e a instituição quando o trabalho usar dados ou recursos do Modal.
Livro ou capítuloNormas da editora. Cessão de direitos compatível com a Política (item 6.1).
Registro de programa de computadorPedido no INPI (Lei nº 9.609/1998), com manifestação prévia do Comitê de PD&I.
Dados ou código abertosLicença definida. Revisão de sigilo e de dados pessoais antes da publicação.
Relatório para financiadorFormato do financiador. Pode reaproveitar o relatório técnico.

8. Série de Relatórios Técnicos do Modal

  • Formato: o formato preferencial é Markdown, a partir do modelo 04, convertido com o modal-md2doc, que já gera o documento no padrão visual da série. Cada projeto pode usar outra ferramenta (editor de texto, Google Docs, LaTeX com abnTeX2), desde que o PDF final mantenha a estrutura do modelo 04, a ficha de identificação, as declarações e a capa da série.

  • Identificação: RT-Modal AAAA-NN, numerada em sequência anual (ex.: RT-Modal 2026-01).

  • Revisão: antes da publicação, o Comitê de PD&I faz a revisão editorial. Verifica estrutura, clareza, declarações, sigilo e propriedade intelectual. Não é revisão por pares cega; é a garantia mínima de qualidade da série.

  • Publicação: depósito no Zenodo, na comunidade do Instituto, com DOI, licença (padrão: CC BY 4.0) e metadados de autoria. O depósito é preparado a partir do registro Produto no eLabFTW, em rascunho e com o DOI reservado; a publicação é feita pela conta do Instituto depois da revisão editorial. Versões corrigidas recebem nova versão no mesmo registro.

  • Relatórios com informação restrita: quando o conteúdo integral não puder ser divulgado, publica-se uma versão pública com a informação sigilosa retirada, e a versão integral fica arquivada no Modal com a mesma numeração.

9. Pesquisa retrospectiva

Às vezes a pesquisa é reconhecida depois que o trabalho aconteceu, como num projeto que só mais tarde se mostra digno de estudo. Isso é legítimo, desde que:

  • o plano seja montado depois e declarado como retrospectivo;

  • as evidências sejam as que existiam à época (commits, issues, registros), e não lembranças reconstruídas;

  • o relatório trate como ameaça à validade o viés de quem participou do trabalho e agora o avalia.

Para fins de prestação de contas a financiadores, atividade anterior à formalização pode não ser aceita como despesa. Isso é questão de gestão, a ser verificada no instrumento de fomento, e não afeta a validade científica.

10. Ética, dados, propriedade intelectual e declarações

10.1. Pessoas e dados pessoais

  • Mínimo: o plano diz se a pesquisa envolve pessoas como participantes (entrevistas, questionários, observação) ou dados pessoais.

  • Pesquisa com seres humanos segue as Resoluções CNS nº 466/2012 e nº 510/2016. O pesquisador verifica se o caso exige submissão a Comitê de Ética em Pesquisa ou se está dispensado, e registra a conclusão no projeto. Bolsistas apresentam o parecer ou a declaração de dispensa (Regulamento de Bolsas, art. 28).

  • Tratamento de dados pessoais segue a LGPD e a Política de Privacidade do Modal. O plano indica a base legal aplicável. Em ambiente de trabalho, o consentimento costuma não ser a base adequada; as mais comuns são a realização de estudos por órgão de pesquisa (art. 7º, IV) e o legítimo interesse. Sempre que possível, os dados são anonimizados antes da análise e da publicação.

10.2. Sigilo e propriedade intelectual

  • Mínimo: o plano indica se há parceiro, se há informação sigilosa e quem é titular dos resultados, conforme o instrumento de parceria (Política, item 6.1).

  • Nada é publicado sem verificar o sigilo devido ao parceiro e o potencial de proteção do resultado. A manifestação é do Comitê de PD&I.

10.3. Autoria e contribuição

Assina como autor quem contribuiu de forma substancial para a concepção, a execução ou a análise e para a redação ou revisão crítica do texto. As demais contribuições são reconhecidas em agradecimentos. Recomenda-se descrever a contribuição de cada autor segundo a taxonomia CRediT. A ordem dos autores é combinada pela equipe; na falta de acordo, segue a contribuição, e o pesquisador-líder decide os empates.

10.4. Uso de inteligência artificial na pesquisa

O uso de ferramentas de IA generativa na condução da pesquisa ou na redação dos produtos é declarado: qual ferramenta, para quê e como o resultado foi verificado. A responsabilidade pelo conteúdo é sempre dos autores. Quando a IA é o próprio objeto da pesquisa, o relatório descreve versões e configurações das ferramentas para permitir comparação.

11. Linguagem dos documentos

Os documentos de pesquisa do Modal são lidos por pesquisadores, gestores, parceiros e financiadores. A linguagem deve servir a todos:

  • Clara e direta. Frases curtas, uma ideia por frase, voz ativa. Prefira "a equipe mediu" a "foi realizada a medição".

  • Pessoa gramatical consistente. Use a primeira pessoa do plural ("medimos", "concluímos") ou a forma impessoal, sem alternar no mesmo documento.

  • Precisa. Números com unidade, período e fonte. "Reduziu de 12 para 7 dias o tempo médio de entrega, entre março e junho de 2026 (E04)", e não "reduziu muito o tempo".

  • Sustentada. Toda afirmação relevante tem evidência ou referência. O que é interpretação aparece como interpretação ("isso sugere", "uma explicação possível").

  • Sóbria. Sem adjetivos promocionais ("revolucionário", "inovador", "disruptivo"). O resultado convence pelo que mostra.

  • Honesta sobre a incerteza. Diga o que não se sabe, o que não funcionou e onde o resultado não se aplica.

  • Acessível. Termo técnico, sigla ou estrangeirismo é explicado na primeira ocorrência; estrangeirismos em itálico.

  • Respeitosa. Pessoas e organizações são descritas sem juízo de valor e, quando necessário, anonimizadas.

As referências seguem a ABNT NBR 6023, e o resumo, a ABNT NBR 6028.

12. Onde a pesquisa é registrada

12.1. eLabFTW: ferramenta padrão

O registro da pesquisa é feito no eLabFTW do Modal (https://pdi.modal.org.br), um caderno eletrônico de pesquisa de software livre, hospedado em servidor do Instituto, com cópias de segurança diárias. Ele guarda o histórico de cada alteração, identifica o autor de cada registro, controla quem vê o quê e exporta tudo em formato aberto.

O uso é obrigatório para plano, caderno, desvios, relatórios de marco, evidências e produtos de todo projeto iniciado a partir da aprovação destas diretrizes pelo Diretor de Pesquisa e Inovação. Exceção só com justificativa registrada na proposta ao Comitê de PD&I; por exemplo, quando o instrumento de parceria exige outra ferramenta. Nesse caso, a equipe usa os modelos em Markdown (seção 14) e mantém a mesma estrutura.

Das diretrizesNo eLabFTW
Ficha do projeto (identificação, equipe, situação, pendências)Recurso da categoria Projeto de pesquisa
Plano de pesquisa (modelo 01)Experimento da categoria Plano de pesquisa
Entrada do caderno (modelo 02)Experimento da categoria Registro de caderno
Desvio do planoExperimento da categoria Desvio do plano
Relatório de marco (modelo 03)Experimento da categoria Relatório de marco
Evidência (E01, E02...)Recurso da categoria Evidência
Produto (relatório, artigo, registro de software...)Recurso da categoria Produto

Todos os registros de um projeto são ligados à ficha do projeto, que funciona como sumário. Cada categoria tem um modelo com as seções, os campos e as listas de verificação destas diretrizes; o uso do modelo é obrigatório no app.

Acesso. Cada projeto tem um grupo de usuários com a sua equipe. Quando a proposta é aprovada pelo formulário do site, o grupo é criado automaticamente, com o proponente; nos demais casos, por um administrador. Os demais integrantes são incluídos por um administrador. Os registros do projeto ficam visíveis só para esse grupo e para os administradores; quem edita é o autor de cada registro. A ficha do projeto pertence ao pesquisador-líder: ele é o dono da ficha no eLabFTW e recebe os lembretes do projeto. Pesquisadores do Modal se cadastram com o e-mail institucional; proponentes de propostas aprovadas pelo site recebem a conta automaticamente; parceiros e bolsistas externos recebem conta criada por um administrador.

12.2. O que fica fora do eLabFTW

  • Redação dos produtos. Cada equipe escolhe a ferramenta de redação; Markdown com o modal-md2doc é a preferencial (seção 8). O registro Produto no eLabFTW aponta para o arquivo e, depois, para o DOI.

  • Documentos administrativos. Formalização, termos de sigilo e de parceria e parecer de ética ficam no repositório de documentos do Instituto. A ficha do projeto aponta para eles.

  • O trabalho em si. Código, issues, planilhas e documentos continuam onde a equipe trabalha. O eLabFTW aponta para eles; não os substitui.

Para esses arquivos, a pasta modelo Estrutura-de-Projeto/ continua disponível, com nomeação AAAA-nome-curto (ex.: 2026-ia-desenvolvimento-software). Nela, só as subpastas 04-produtos e 05-administrativo são necessárias quando o projeto usa o eLabFTW.

13. Relação com outros normativos

  • Política de PD&I (2025): prevalece em governança, proposta, formalização, acompanhamento, propriedade intelectual e relatório anual. Estas diretrizes a complementam.

  • Regulamento de Bolsas (2022): permanece válido para concessão e acompanhamento de bolsas. Os modelos destas diretrizes atendem ao Plano de Pesquisa (art. 23) e aos relatórios parciais e final exigidos dos bolsistas.

14. Modelos

NºModeloMomentoSituaçãoOnde
01Plano de PesquisaAntesMínimoModelo no eLabFTW; Markdown só nas exceções
02Caderno de PesquisaDuranteMínimoModelos "Registro de caderno" e "Desvio do plano" no eLabFTW; Markdown só nas exceções
03Relatório de MarcoDuranteDesejável; mínimo para bolsistas (relatório parcial)Modelo no eLabFTW; Markdown só nas exceções
04Relatório TécnicoDepoisConforme o produto escolhidoPreferencialmente Markdown com o modal-md2doc; outras ferramentas aceitas (seção 8)

Referências

BRASIL. Conselho Nacional de Saúde. Resolução nº 466, de 12 de dezembro de 2012. Brasília, 2012. Disponível em: https://conselho.saude.gov.br/resolucoes/2012/Reso466.pdf.

BRASIL. Conselho Nacional de Saúde. Resolução nº 510, de 7 de abril de 2016. Brasília, 2016. Disponível em: https://conselho.saude.gov.br/resolucoes/2016/Reso510.pdf.

BRASIL. Lei nº 9.609, de 19 de fevereiro de 1998. Dispõe sobre a proteção da propriedade intelectual de programa de computador. Brasília, 1998. Disponível em: https://www.lexml.gov.br/urn/urn:lex:br:federal:lei:1998-02-19;9609.

BRASIL. Lei nº 13.709, de 14 de agosto de 2018. Lei Geral de Proteção de Dados Pessoais (LGPD). Brasília, 2018. Disponível em: https://www.lexml.gov.br/urn/urn:lex:br:federal:lei:2018-08-14;13709.

HEVNER, A. R.; MARCH, S. T.; PARK, J.; RAM, S. Design science in information systems research. MIS Quarterly, v. 28, n. 1, p. 75-106, 2004. DOI: https://doi.org/10.2307/25148625.

INSTITUTO MODAL. Política de Pesquisa, Desenvolvimento e Inovação – PD&I. Versão 1.0.1. Brasília, 2025. Disponível em: https://modal.org.br/wp-content/uploads/2026/05/2025PDI0201.Modal_.101.pdf.

INSTITUTO MODAL. Regulamento para concessão de bolsas de pesquisas, de estudos, de fomento à formação e de apoio técnico à pesquisa. Versão 1.1.1. Brasília, 2022. Disponível em: https://modal.org.br/wp-content/uploads/2025/01/2022REG0610-RegulamentoBolsas_v1.1.1.pdf.

KITCHENHAM, B. A.; BUDGEN, D.; BRERETON, P. Evidence-based software engineering and systematic reviews. Boca Raton: CRC Press, 2015. DOI: https://doi.org/10.1201/b19467.

NISO – NATIONAL INFORMATION STANDARDS ORGANIZATION. CRediT: Contributor Roles Taxonomy. Disponível em: https://credit.niso.org/.

OECD. Frascati Manual 2015: guidelines for collecting and reporting data on research and experimental development. Paris: OECD Publishing, 2015. DOI: https://doi.org/10.1787/9789264239012-en.

PEFFERS, K.; TUUNANEN, T.; ROTHENBERGER, M. A.; CHATTERJEE, S. A design science research methodology for information systems research. Journal of Management Information Systems, v. 24, n. 3, p. 45-77, 2007. DOI: https://doi.org/10.2753/MIS0742-1222240302.

RALPH, P. et al. Empirical standards for software engineering research. arXiv:2010.03525, 2020. Disponível em: https://arxiv.org/abs/2010.03525. Versão mantida em: https://github.com/acmsigsoft/EmpiricalStandards.

RATTON, E.; WAYDZIK, F. A.; MACHADO, V. Manual de normalização de relatórios técnicos e/ou científicos: de acordo com as normas da ABNT. Curitiba: UFPR, 2019. Disponível em: https://tecnologia.ufpr.br/wp-content/uploads/2019/10/Manual-de-Normalização-de-relatórios-técnicos-e-ou-científicos_online.pdf.

RUNESON, P.; HÖST, M. Guidelines for conducting and reporting case study research in software engineering. Empirical Software Engineering, v. 14, n. 2, p. 131-164, 2009. DOI: https://doi.org/10.1007/s10664-008-9102-8.

STARON, M. Action research in software engineering: theory and applications. Cham: Springer, 2020. DOI: https://doi.org/10.1007/978-3-030-32610-4.

WIERINGA, R. J. Design science methodology for information systems and software engineering. Berlin: Springer, 2014. DOI: https://doi.org/10.1007/978-3-662-43839-8.

WOHLIN, C. et al. Experimentation in software engineering. Berlin: Springer, 2012. DOI: https://doi.org/10.1007/978-3-642-29044-2.

YIN, R. K. Estudo de caso: planejamento e métodos. 5. ed. Porto Alegre: Bookman, 2015. Disponível em: https://minhabiblioteca.com.br/catalogo/livro/74317/estudo-de-caso/.

Nota sobre as normas ABNT. As normas NBR 6023, 6028 e 10719 são vendidas pela ABNT e não têm acesso aberto. Como referência acessível da NBR 10719, use o manual de Ratton, Waydzik e Machado (2019).

Apêndice A — Guia de uso do eLabFTW

O passo a passo do eLabFTW, com as telas reais e um projeto de exemplo preenchido campo a campo, está no Guia de Uso do eLabFTW: https://modal.org.br/docs/guia-uso-elabftw.html. O Guia é atualizado sempre que o eLabFTW ou as rotinas automáticas mudam; este apêndice registra só o essencial.

  • Acesso: https://pdi.modal.org.br, com Firefox, Chrome ou Edge (o Safari não é suportado). Pesquisadores do Modal se cadastram com o e-mail @modal.org.br; parceiros e bolsistas externos pedem a conta pelo e-mail pesquisa@modal.org.br. O segundo fator de autenticação é opcional.

  • Criar a partir do modelo: todo registro é criado pelo botão Criar > Começar a partir de um modelo, escolhendo o modelo da categoria (Guia, seção 4). Sem o modelo, o registro nasce sem campos, seções e listas de verificação.

  • Ligar à ficha: cada registro é ligado à ficha do projeto, e cada entrada de caderno, às evidências que a sustentam (Guia, seção 8).

  • Restringir o acesso: cada registro fica visível só para o dono, os administradores e o grupo do projeto (Guia, seção 5.3). Em projeto com parceiro, não use "Apenas membros da equipe": a equipe do eLabFTW reúne todos os pesquisadores do Modal.

  • Sigilo e dados pessoais: 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 e anonimize antes de anexar.

  • Rotinas automáticas: o sistema numera as evidências ligadas à ficha (E01, E02...), preenche com "Restrito ao parceiro" o sigilo deixado vazio, avisa a equipe quando a situação de um registro muda, lembra o pesquisador-líder quando o caderno fica parado além do prazo da ficha (padrão de 30 dias, ajustável no campo "Dias sem caderno para lembrete"), confere os registros todo mês e cria, em rascunho, o depósito no Zenodo dos produtos marcados para isso (Guia, seção 11).

  • Cuidados: o texto principal só é gravado no botão Salvar; campos obrigatórios não impedem salvar; cada alteração gera revisão, sem perda de histórico; o uso de IA para redigir registros é declarado no próprio registro.

  • Dúvidas e problemas: pesquisa@modal.org.br.