Instruções para alunos de Iniciação Científica

Esta página tem por objetivo dar algumas instruções gerais a alunos sob minha orientação em trabalhos de Iniciação Científica (IC).

Conheça o programa e o projeto de pesquisa:

Familiarize-se com o regulamento geral da Iniciação Científica na Ufes.

Para seu ingresso na IC, foi escrito um sub-projeto de pesquisa que é inserido no contexto de um projeto de pesquisa registrado na PRPPG. Leia atentamente tanto o projeto quanto o sub-projeto e certifique-se que você entende a visão geral apresentada nesses documentos.

Existem modelos de documento para os relatórios parcial e final no site do Programa Institucional de Iniciação Científica (ao final da página). Observe as instruções que constam nesses modelos e utilize-os como base para seus relatórios. No entanto, use ou o LibreOffice Writer 4, ou o Microsoft Word 2013, salvando o arquivo no formato ODT ou DOCX antes de enviá-lo a mim.

Controle suas atividades, prazos e compromissos:

Além de estabelecer o problema a ser resolvido, o sub-projeto de pesquisa detalha as atividades que serão conduzidas e um cronograma indica quais atividades ocorrem em cada mês do projeto. Acompanhe esse cronograma ao longo da IC para saber se você está em dia ou atrasado em relação às atividades previstas. Em caso de atrasos, converse comigo.

Fique atento aos prazos para envio dos relatórios parcial e final da IC. Os prazos são, geralmente, final de janeiro/início de fevereiro para o relatório parcial e final de agosto para o relatório final. Verifique a data exata no calendário anual da IC ou no edital PIIC do ano em questão.

Durante o período da IC faremos reuniões semanais para acompanhamento do projeto. Todos meus compromissos são marcados em minha agenda do Google. Sugiro que você tenha uma conta Google para que eu possa adicioná-lo(a) à reunião como convidado(a) e você seja notificado(a) do horário da reunião.

Ao longo do trabalho, produza também documentação técnica (requisitos, projeto de sistema, etc.), pois você poderá utilizar o que for desenvolvido durante a IC para seu projeto de graduação (PG).

Integre-se ao grupo de pesquisa:

A atividade de Iniciação Científica é a porta de entrada de alunos de graduação em atividades de pesquisa. Nesse tipo de atividade, a participação em um grupo de pesquisa é muito importante, pois permite o compartilhamento de conhecimento e enriquece a experiência da IC.

Sugere-se, portanto, que você integre-se ao Nemo (Núcleo de Estudos em Modelagem Conceitual e Ontologias), de diferentes formas:

  • Conheça os alunos do grupo e faça amizades. Frequente o laboratório (CT-7, sala 11) e verifique se há espaço para que você trabalhe ali diariamente. Caso contrário, pergunte pelo Nemo Extension;
  • Participe dos seminários do Nemo para conhecer em que seus colegas de grupo estão trabalhando. Apresente um seminário você também sobre seu trabalho;
  • Assista às jornadas de IC, apresentações de PG, defesas de mestrado/doutorado de colegas de grupo, para ver como funcionam e ter exemplos de trabalhos bem feitos (e outros nem tão bem feitos assim), julgando a partir dos comentários dos membros da banca;
  • Quando tiver dúvidas e ainda faltar um tempo para a próxima reunião comigo, tente resolvê-las com colegas de grupo. Muitas vezes outros colegas já passaram pelos problemas/dúvidas que você está passando e podem ajudar. Em especial quando são dúvidas mais práticas ou sobre procedimentos burocráticos é mais provável que os seus colegas no Nemo saibam mais do que eu sobre o assunto.

Revise bem seus documentos:

Ao escrever qualquer documento, é muito importante que você utilize um corretor ortográfico. Enviar documentos com erros simples de digitação ou de português que poderiam ser capturados por corretores automáticos é sinal de que você não está levando o trabalho a sério. Caso esteja usando um editor específico (ex.: editor LaTeX) que não possui corretor ortográfico, copie e cole o texto em um editor que possua esse recurso e utilize-o.

Editores de texto como LibreOffice Writer e Microsoft Word possuem suporte a diferentes línguas. Antes de passar o corretor ortográfico é importante assegurar-se que o texto encontra-se “formatado” para a língua correta. No LibreOffice, tal configuração encontra-se na formatação do caractere/fonte. No Word, encontra-se no menu Ferramentas/Tools.

Além do corretor ortográfico, revise seu documento para garantir que não há erros simples, que você mesmo poderia capturar antes de enviá-lo a mim. Um trabalho que exige muitas correções simples de minha parte demora mais para retornar a você, pois se torna cansativo de revisar. Quanto melhor o documento enviado, mais rápido você o recebe de volta para continuar seu trabalho. Em casos extremos, pode ser que eu me recuse a revisar o texto até que ele tenha um mínimo de qualidade.

Quaisquer documentos (relatórios, documentação técnica, artigo, etc.) enviados a mim poderão sofrer revisão e retornar a você para que efetue melhorias e modificações. Sobre esse assunto, por favor leia com atenção a seção a seguir.

Sobre a revisão de documentos:

Documentos enviados a mim, sejam eles relatórios, documentação técnica, monografia, dissertação, etc. serão, em alguns casos, revisados e devolvidos com anotações para que você efetue modificações para melhorar o trabalho.

Qualquer que seja o documento, para podermos ter um histórico da revisão vou anexar um número de versão ao documento quando fizer a primeira revisão no mesmo. Por exemplo, você me manda o documento PG-Fulano.docx, eu faço a revisão e devolvo PG-Fulano_v2.docx. A partir daí, caso você me envie o mesmo documento para uma segunda rodada de revisão, deve incrementar o número de versão antes de enviá-lo. Continuando o exemplo anterior, você faz as modificações, renomeia o arquivo para PG-Fulano_v3.docx e me manda. Em seguida eu retorno com PG-Fulano_v4.docx e assim por diante, até a versão final (PG-Fulano_vFinal.docx).

No caso de documentos ODT ou DOCX, a revisão será feita utilizando o mecanismo de controle de alterações (track changes) do editor de texto. Documentos ODT serão revisados no LibreOffice Writer 4 e documentos DOCX no Microsoft Word 2013. O aluno não deve usar o Word para salvar documentos ODT ou o Writer para salvar documentos DOC/DOCX. Caso o template possua uma extensão diferente do programa que deseja usar, abra-o e salve com a extensão adequada antes de me enviar o documento.

Modificações feitas por mim podem ser vistas diretamente no documento, sublinhadas e coloridas pelo próprio editor. Pedidos/sugestões de modificação serão feitos com comentários/anotações/notas que são exibidas ao lado direito do documento.

Ao mexer em um documento que já foi revisado por mim, você deve:

  1. Certificar-se que configurou seu nome e iniciais no editor, pois o sistema de revisão utiliza o nome do usuário para indicar quem fez qual alteração:
    • No Writer, clique no menu Ferramentas / Opções (Tools / Options na versão em inglês) e no item Libre Office / Dados do usuário (LibreOffice / User Data) preencha o campo Nome/Sobrenome/Iniciais (First/Last name/Initials);
    • No Word 2013, basta que você esteja identificado com sua conta Microsoft e ele usará as informações do seu perfil.

     

  2. Revisar todas as modificações que eu fiz, aceitando-as caso concorde e rejeitando-as caso não concorde. No caso de rejeição, adicione um comentário/anotação justificando a rejeição:
    • No Writer, para revisar as modificações clique no menu Editar / Alterações / Aceitar ou rejeitar… (Edit / Changes / Accept or reject). Para adicionar uma anotação, clique no menu Inserir / Anotação (Insert / Note);
    • No Word, use a aba Revisão (Review) para o controle de alterações. A caixa de seleção Mostrar Marcações (Show Markup) permite que você escolha como deseja ver as modificações feitas. Para revisar, clique no botão Painel de Revisão (Review Pane) e utilize os botões Aceitar (Accept) e Rejeitar (Reject). Para adicionar um comentário, use o botão Novo Comentário (New Comment).

     

  3. Habilitar o controle de alterações antes de fazer qualquer alteração no texto do documento, para que eu saiba o que foi modificado por você quando me enviar a nova versão do documento:
    • No Writer, certifique-se que o item de menu Editar / Alterações / Registrar (Edit / Changes / Record) esteja ativado;
    • No Word, na aba Revisão (Review), certifique-se que o botão Controlar Alterações (Track Changes) esteja ativado.

     

  4. Ao efetuar modificações relacionadas a um comentário/anotação/nota deixado por mim, responder com outro comentário:
    • No Writer, clique na anotação que deseja responder e, com o cursor lá dentro, clique no menu Inserir / Anotação (Insert / Note);
    • No Word, clique no comentário que deseja responder e, com o cursor lá dentro, use o botão Novo Comentário (New Comment). Alternativamente, utilize diretamente o botão específico para responder comentários, presente no próprio comentário.

     

  5. Caso esteja trabalhando em uma seção completamente nova, desligar o controle de alterações, pois aquela seção do documento será revisada do zero, como se fosse um documento novo. Além disso, indique com um comentário as seções que são novas para que eu saiba que devo revisá-las.
     

No caso de uso de LaTeX, leia atentamente o post Controle de alterações em LaTeX usando Git e SourceTree. Observe também as instruções da seção a seguir.

Sempre que possível e indicado, use o LaTeX

Editores como o Word e o Writer são muito poderosos e versáteis. Porém, em determinadas situações, é mais indicado usar uma ferramenta que guie a escrita do documento de forma mais estruturada. O LaTeX é uma ferramenta desse tipo, que força o autor a concentrar-se no conteúdo, enquanto a ferramenta lida com toda a parte de formatação. Um exemplo simples de documento LaTeX pode ser visto neste site.

Quando o uso de um template RTF/DOC/ODT não é obrigatório, recomendo o uso do LaTeX. Após um esforço inicial de acostumar-se a um editor não WYSIWYG, o LaTeX te livra de uma série de preocupações:

  • Não é necessário preocupar-se com questões de formatação: qual é o tipo de tamanho das fontes, espaçamento, primeira linha, margens da página, etc. Vários leiautes prontos encontram-se disponíveis, praticamente toda conferência e periódico oferece templates prontos, evitando que o artigo seja rejeitado por má formatação;
  • Seções, tabelas, listagens, figuras todas recebem um nome e as referências cruzadas no código-fonte são feitas a esse nome, sendo transformadas automaticamente pelo LaTeX para o número adequado, autualizando-o automaticamente quando este muda;
  • Referências bibliográficas com BibTeX são gerenciadas automaticamente, adicionando a citação onde você indicar e criando a seção de referências automaticamente somente com os trabalhos citados;
  • Escrita de equações matemáticas e uso de símbolos especiais (letras gregas, por exemplo) é mais simples com LaTeX do que em editores WYSIWYG como Word e Writer.

A única área que o LaTeX dificulta muito a vida do autor é no uso de tabelas, em especial tabelas complexas com muitas células mescladas e formatação especial. Em certos casos, é mais fácil produzir a tabela em outro editor e gerar uma imagem da mesma, inserindo-a como uma figura no documento.

Tutoriais sobre LaTeX e BibTeX podem ser encontrados facilmente na Internet. Na página oficial do LaTeX há um link para uma The (Not So) Short Introduction to LaTeX2e como tutorial LaTeX e a Wikipedia cita o artigo Bibliographies with BibTeX como tutorial do BibTeX.

No meu blog, escrevi sobre o gerenciamento de bibliografia com Mendeley e BibTeX. Falo sobre o Mendeley a seguir.

Alguns editores que facilitam o trabalho de escrever em LaTeX: TeXstudio (que eu atualmente uso e recomendo), Texmaker, TeXworks, TeXShop (este último somente para MacOS). Ambientes online como o Overleaf permitem a edição de LaTeX de maneira colaborativa.

A instalação de um editor, no entanto, pode não trazer junto a plataforma LaTeX (com o compilador, suas bibliotecas, pacotes, etc.), que também será necessária para a edição de documentos nesse formato. O site do abnTeX2, que utilizo como base para os modelos de monografia (PG) e dissertação (Mestrado), traz orientações de instalação do LaTeX e do abnTeX2, que pode te ajudar a configurar o ambiente inicial.

Por fim, o site writeLaTeX pode te auxiliar a aprender LaTeX a partir de exemplos. A seção TeX do Stack Exchange funciona como um Stack Overflow para TeX e é um ótimo local para procurar respostas e, caso não as encontre, perguntar.

Gerencie os artigos que você lê com o Mendeley

Durante a produção de um trabalho acadêmico, principalmente de mestrado e doutorado, um aluno deve ler muitos artigos, relatórios técnicos, capítulos de livro e documentos em geral. Depois de uma certa quantidade, pode ser difícil lembrar dos artigos que já leu para poder citá-los quando desejado. Sugere-se, então, o uso de alguma ferramenta de gerenciamento de bibliografia.

Pessoalmente, eu uso e recomendo o Mendeley. Fazendo seu cadastro, você pode usar o Mendeley via Web diretamente ou instalar o Mendeley Desktop, que permite que você gerencie sua biblioteca de artigos offline e sincronize com sua conta no site quando quiser.

Algumas funcionalidades interessantes da ferramenta: registra entradas bibliográficas (ex.: artigos), salva os PDFs na nuvem (sincronizando em diferentes dispositivos), categorização por tipo (ex.: artigo de conferência, de periódico, capítulo de livro, etc.), registro de informações bibliográficas (ex.: nome da conferência, ano, páginas, etc.), criação e atribuição de tags, busca (por autor, por tag, por conferência, texto livre), integração com Word e Writer para criação da seção de referências, exportação das referências em diversos formatos, inclusive BibTeX.

Quando escrevo artigos e outros documentos em LaTeX, eu geralmente uso um arquivo BibTeX único onde mantenho toda a minha bibliografia. Este arquivo eu gero a partir do Mendeley, fazendo uma limpeza nele usando um script que implementei em Java. Em meu blog publiquei em detalhes como usar o Mendeley e o BibTeX para gerenciar sua bibliografia. Sugiro a leitura e o uso dessas ferramentas como descrito.

Nunca deixe nada para a última hora!

Lembre-se que eu possuo várias outras responsabilidades: outros alunos orientados, dar aulas (e outras atividades didáticas), participar de comitês de programa, organizar eventos, escrever artigos, realizar outras pesquisas, cumprir meus próprios prazos, questões burocráticas e, além de tudo, também preciso de férias…

Portanto, sempre que me mandar material para revisão, planeje-se para aguardar até 15 dias para obter retorno. Quando possível, retornarei mais rapidamente, mas dependendo do tamanho da fila de pendências, seu trabalho pode demorar um pouco a ser revisado. Não adianta enviar material para revisão do orientador dizendo que o prazo para entrega é o dia seguinte, pois com certeza eu já tenho várias outras tarefas na fila e não é justo que um aluno que não se planejou adequadamente passe na frente de outros.

Analogamente, caso você atrase o desenvolvimento do seu trabalho e, algum tempo depois, decida acelerar o ritmo para compensar o atraso, não espere que eu possa/queira acelerar o meu ritmo para poder te acompanhar. Não espere, por exemplo, que dê pra aumentar a frequência de reuniões, ou que eu responda e-mails mais rapidamente, ou ainda que eu trabalhe durante finais de semana, feriado ou férias.

Com relação a férias, aliás, é esperado que eu esteja de férias durante 30 dias no início do ano (durante o recesso de verão) e outros 15 dias no meio do ano (durante o recesso de inverno). Não espere que eu responda e-mails de trabalho durante esses períodos.

Entenda o perfil do seu orientador

Como você já pôde perceber (por convivência comigo ou simplesmente por ler essa página), eu sou uma pessoa muito organizada e sistemática, valorizo muito a pontualidade, defendo a conformidade com as regras — não gosto de dar “jeitinho brasileiro” em nada e acho que as coisas deveriam funcionar na prática como estão no papel — e gosto do meu trabalho.

Entender esse meu perfil e agir de forma compatível vai te ajudar bastante enquanto você for meu orientado. Alunos desorganizados; que estão constantemente atrasados ou procrastinando; que aparentam não estarem interessados no trabalho; que rotineiramente produzem material de baixa qualidade; e/ou acham que as coisas no final podem ser resolvidas no “jeitinho” naturalmente serão considerados com menor prioridade dentre meu conjunto de alunos.

Nessa relação orientador-orientado, é pouco provável que eu mude o meu jeito para adequá-lo a cada um dos meus alunos. Portanto cabe a você, aluno, adequar-se se quiser percorrer uma estrada com menos obstáculos no caminho.