Conselhos para a Escrita do Artigo

Estas regras pretendem ajudá-lo a escrever um texto científico com boa qualidade técnica e editorial. Siga-as e verá os resultados. É claro que nada substitui o empenho e a concentração no que se está a escrever ...
Não dê para ler os seus textos a outras pessoas sem confirmar que estas regras foram seguidas.

Regra fundamental: O autor tem de “gostar” do texto que escreveu porque o texto conta uma “boa história” com um sequência lógica clara, uma estrutura adequada, frases precisas e concisas, bons exemplos, boas figuras e com bom aspecto gráfico.

Estrutura

• O texto deve ter uma sequência lógica clara onde as várias secções e parágrafos se encadeiam de modo natural.
• Qualquer texto com um número significativo de secção e sub-secções deve incluir um índice no início. O índice deve ser bem estruturado e numerado de forma a que dê imediatamente uma ideia da organização e do conteúdo do texto em questão.
• A sequência de secções ou parágrafos deve partir do mais geral para o mais particular; o que é mais importante deve aparecer antes do que é menos importante.
• A estrutura dos capítulos deve ser tal que contenha secções e sub-secções de forma equilibrada, cada uma contendo partes relativamente separadas do trabalho.  A primeira secção deve começar no princípio do capítulo.
• Não criar apenas uma secção (sub-secção) dentro de um capítulo (secção).

Português e Inglês

• O texto deve ser escrito no tempo presente (excepto quando se relatam factos do passado) e na forma impessoal (não na primeira pessoa do singular ou do plural).
• O texto deve ser consistente e uniforme no seu conjunto, nomeadamente em termos de estilo de escrita.
• As frases devem ser claras e precisas, devendo evitar-se frases demasiado compridas ou demasiado curtas; a escrita deve ser claramente de índole técnico, devendo evitar-se demasiada informalidade.
• De preferência, as frases devem seguir a estrutura mais clara e simples ou seja sujeito-predicado-complementos; quanto menos jeito se tem para escrever, menos se deve complicar.
• Devem evitar-se longos parágrafos de texto corrido para descrever uma lista de coisas ou os vários passos de um algoritmo; em benefício da compreensão, deve usar-se aqui uma sequência de bullets, eventualmente numerada.
• É essencial que o autor perceba tudo o que escreve; frases incompreensíveis, tantas vezes traduzidas à letra de textos em Inglês, são inaceitáveis.
• O uso de termos de Inglês deve ser o mais reduzido possível, limitando-se aos termos cuja tradução é difícil ou cujo uso é já corrente; quando usados devem aparecer em itálico.

Conteúdo

• O Resumo ou Abstract não deve conter frases demasiado generalistas, mas antes frases curtas descrevendo os principais objectivos e resultados do trabalho.
• A Introdução deve começar por dar uma ideia do contexto e motivação do trabalho em questão e, à medida que vai progredindo, deve ir fornecendo informação mais específica, até se abordar directamente o assunto em questão. Depois disso, devem apresentar-se a estrutura e conteúdo do texto.
• As Conclusões devem conter os principais resultados do trabalho e eventualmente indicações de trabalho futuro.
• Os Anexos contêm informação adicional, que não é fundamental para a compreensão do trabalho, ou que é suplementar ao corpo principal do texto.

Títulos

• Os títulos de capítulos, secções, etc. devem ser claros e traduzir fielmente o conteúdo do texto a que se referem.
• Secções de algum modo paralelas devem ter títulos semelhantes de forma a evidenciar esse paralelismo e a manter a coerência do conjunto.
• O uso de maiúsculas e minúsculas nos títulos deve ser feito de modo consistente.
• Deve ajustar-se o tipo e tamanho da letra dos títulos das várias secções consoante o seu nível na estrutura do índice.
• Os títulos das várias secções devem usar um tipo e tamanho de letra dependendo do seu nível dentro do índice.
• Não se devem incluir referências no título de capítulos, secções ou sub-secções.

Terminologia

• Deve ser definida de modo claro e preciso antes de ser usada, de preferência de modo graficamente saliente, p.e. usando bullets com o termo a bold.
• Deve ser consistentemente usada depois de definida (evitar o uso de outros termos com o mesmo significado).
• Deve evitar-se o uso de termos não definidos ou cujo significado não é consensual sem providenciar uma definição; para os casos menos importantes, a definição pode aparecer no corpo do texto.

Aspecto gráfico

• O aspecto gráfico é muito importante porque pode facilitar substancialmente a leitura do texto; as páginas devem ter um aspecto “agradável”.
• Para melhor organizar o texto, devem usar-se as listas, bullets, etc. sempre que necessário.
• Para salientar alguns elementos deve usar-se o bold, itálico, etc. sempre que necessário.

Figuras e Tabelas

• É importante o uso de figuras e tabelas para complementar o texto, auxiliando a sua compreensão.
• As figuras e tabelas não devem incluir informação que não pode ser compreendida por não ter sido referida no texto associado.
• Só há figuras e tabelas ou seja quadros, gráficos, etc. não 'existem'.
• As figuras e tabelas devem ser sempre referidas no texto e normalmente explicadas.
• As figuras e tabelas não devem nunca aparecer antes de serem referenciadas no texto.
• As figuras e tabelas devem aparecer centradas horizontalmente na página.
• Algum espaço adicional deve ser deixado antes e depois das figuras e tabelas e entre a legenda e a figura ou tabela.
• As legendas devem ser claras e bem organizadas mas não devem servir para explicar longamente a figura ou tabela.
• As legendas devem aparecer centradas na página.
• As figuras contendo gráficos devem possuir legendas nos dois eixos, com a grandeza representada e as respectivas unidades.
• Quando se usam figuras ou tabelas de outros autores, esse facto deve ser incluído na legenda; por exemplo: “Figure 4.5 – Arquitectura do sistema [6].”.

Equações

• <> As equações devem ser alinhadas à esquerda e numeradas.
• As equações devem ser referidas apenas pelo seu número. Por exemplo: “deduz-se de (30) que não existe variação com a frequência”.
• Os símbolos matemáticos devem ser escritos em itálico.
• Os símbolos devem ser definidos depois das equações, na primeira vez que são utilizados.
• Não se pode usar o mesmo símbolo para grandezas diferentes.
• Deve ter-se o cuidado de escrever o mesmo símbolo sempre da mesma forma, isto é, com o mesmo tamanho, com o mesmo significado, etc.
• Quando se tem números que ultrapassam os milhares, deve usar-se um espaço para separar os milhares, isto é, deve usar-se 12 345 em vez de 12345.
• Para textos em Português, deve usar-se uma vírgula e não um ponto para indicar as casas decimais ou seja deve usar-se 5,67 e não 5.67. O contrário acontece para textos em Inglês.

Exemplos

• A inclusão de exemplos é muito importante para melhor perceber o texto.
• Os exemplos devem ser sempre o mais representativos possível; exemplos demasiado específicos devem ser evitados.

Acrónimos

• Devem ser definidos a primeira vez que são usados.
• No caso de teses, deve incluir-se no início uma lista de acrónimos.

Unidades

• Usam-se as unidades e regras do Sistema Internacional.

Referências

• É essencial incluir uma ou mais referências sempre que se façam afirmações importantes que não vão ser demonstradas ou que se cite trabalho de outros.
• Não se devem incluir referências na lista de referências que não apareçam no texto.
• A lista de referências deve estar ordenada por ordem de entrada da referência no texto.
• As referências devem ser citadas no texto usando [], e.g. 'como foi demonstrado em [17]'.
• As referências na secção de referências devem estar completas, ser consistentes e seguir de forma precisa o formato indicado.

Spelling

• Antes de imprimir o texto, use sempre o corrector de ortografia do processador de texto (spelling). Com as ferramentas existentes, é inaceitável que o seu texto contenha erros ortográficos.