Escrita Técnica

ADSA - 2008-2009Adaptado dos slides de Câmara

(2002) sobre comunicação técnica

Escrita Técnica

• Escrita Técnica e Engenharia do Ambiente

• Objectivos genéricos• Estrutura• Forma• Processo da Escrita

Como é que a escrita afecta a carreira?

• Pelo menos 25% do tempo de um Engenheiro é gasto a escrever

• Empregadores consideram que a dificuldade de comunicar correctamente condiciona o sucesso da carreira

Os Eng. são chamados a escrever e a falar numa variedade de situações

• Conferências• Reuniões• Apresentações públicas

•Posters•Emails•Propostas•Relatórios•Artigos Cientificos•Teses•Páginas na Web•Press releases•Criticas

• Técnicos• Decisores/Políticos• Cidadãos

Objectivos Genéricos• A comunicacão técnica tem como objectivo informar

e convencer. • Devemos escrever

– com clareza– com consistência– com imparcialidade– com objectividade– com precisão– de modo ordenado e fluido– sem erros ortográficos e gramaticais– respeitando as convenções (figuras, quadros, referências)

Deve-se começar por analisar as restrições

• Audiência:– Quem são? – O que sabem do assunto?– Como vão ler? E para quê?

• Ocasião– Formato, convenções e ética– Formalidade– Prazos

• Objectivo– Informar – Convencer

3 aspectos a considerar

• Conteúdo: Correcto? Completo? Apropriado?

• Estilo: Estrutura, Ilustrações• Forma: Formato (tipografia, layout

gráfico) e a mecânica (gramática, ortografia, pontuação)

Estrutura

• Início– Titulo - Deve orientar o leitor– Resumo - Diz o que está no documento– Introdução - Prepara o leitor para as partes do meio

• Meio– Apresentação do trabalho feito

• Fim– Analisa os resultados – Perspectiva os desenvolvimentos futuros

• Apendices

Estrutura

• Elementos fundamentais da estrutura em cada secção– parágrafos

• parágrafo(s) de introdução• parágrafos de descrição• parágrafo(s) de conclusão

– parágrafos- mais de 2 e menos de 5 períodos- legibilidade e transição

Estrutura

– períodos devem ter menos de 20 palavras e apresentarem apenas uma inferência

– figuras e tabelas como elemento estruturante (i.e, Scientific American)

Estrutura: Artigos e Relatórios

– Título e autores– Resumo– Introdução

• Apresentação do problema• Relevância• Revisão genérica de abordagens anteriores• Definição dos objectivos para o trabalho

proposto• Organização do artigo

Estrutura: Artigos (cont.)

– Definição do problema• definição clara do problema e sub-problemas

– Revisão da literatura• revisão com base no problema e sub-

problemas definidos anteriormente• identificação das lacunas existentes

Estrutura: Artigos (cont.)

– Metodologia proposta• apresentação da(s) metodologia(s) para a

obtenção de soluções para o problema e sub-problemas enunciados tendo em conta as lacunas identificadas na secção anterior

• implementação da metodologia– descrição da implementação de modo a que seja

replicável

Estrutura: Artigos (cont.)

– Discussão de Resultados• apresentação dos resultados• discussão com identificação e explicação dos

sucessos e insucessos– Conclusões e Desenvolvimentos Futuros

• síntese do trabalho• síntese dos principais resultados• recomendações para trabalho futuro

– Referências

Estrutura: Propostas– Título– Resumo

• definição do problema• relevância• objectivos• metodologia• resultados

– Definição dos objectivos• apresentação do problema e sub-problemas• relevância• definição dos objectivos gerais• definição dos objectivos específicos• definição de objectivos indirectos

Estrutura: Propostas (cont.)

– Revisão da literatura• seguindo a definição de objectivos• identificando as lacunas

– Metodologia proposta• seguindo a definição de objectivos e procurando suprir

as lacunas• definindo e justificando as actividades do projecto e

métodos a utilizar na sua implementação

Estrutura: Propostas (cont.)

– Programa de trabalhos• Definição temporal das actividades• Definição da inter-relação entre as actividades• Definição dos “deliverables” em cada actividade• Definição dos recursos necessários

– Descrição dos recursos existentes

– Definição justificada dos recursos necessários

Estrutura: Propostas (cont.)

– Orçamento do projecto• orçamento total• verbas requeridas

– Equipa do projecto• apresentação genérica• estrutura de funcionamento• Currículos

Estrutura: Memorandos

• Cabeçalho com: Remetente, Destinatários e assunto

• Primeira linha deve indicar o objectivo• Último paragrafo deve indicar uma

acção

Estrutura: email

• Assunto: Específico• Começar como se fosse uma carta normal• Curto (5 frases)• Acrescentem uma boa assinatura (incluindo

contactos e responsabilidade)• Quando o email tiver características

extraordinárias (e.g. attach muito pesado) peçam premissão para o fazer.

• Sejam cuidadosos quando utilizam expressões sarcásticas ou humorísticas.

Ilustrações

• Figuras e Tabelas– Figuras:

• Gráficos: – mostram tendências– cuidado com as legendas e convenções existentes

• Imagens (realismo)• Esquemas e Diagramas (controlo do detalhe)

– Tabelas• Textos e números

• O texto e ilustrações são um todo

Formato

• Os formatos e layout gráfico variam de acordo com as situações

• Sigam o formato adequado para a situação• Tenham atenção aos detalhes. Por exemplo

cada tipo da letra tem a sua força e personalidade

• Kinetic typography http://www.youtube.com/watch?v=vdg1OCZ79Zk

Formato: Tipo de Letra

• Escolham o tipo e tamanho que seja fácil de ler:– 48 pt para Posters– 36 a 24 pt para slides– 18 a 10 pt para relatórios de titulos a footnotes

• Conheçam as regras:– Tipos sans seriff para páginas Web– Cuidado com as maiusculas

Forma: Frases

– Escrever com base em verbos e substantivos– Evitar adjectivos– Escrever utilizando a voz activa– Evitar sucessões de frases soltas– Ter atenção ao paralelismo

• balancear palavras com palavras, frases com frases– A kiss can be a comma, a question mark, or an

exclamation point– In matters of principle, stand like a rock; in matters of taste,

swim with the current

Forma: Frases

– Utilizar a coordenação (através de conjunções como: e, mas, ou) quando se pretende dar idêntica relevância a ideias distintas numa frase

– Evidenciar a subordinação entre frases através de palavras como: depois, embora, porque, se, desde que, quando, onde, enquanto

Forma: Frases

– Utilizar diferentes estruturas para as frases do texto

– Utilizar diferentes palavras para abrir parágrafos

Forma: Frases

• Frases a evitar– É bem conhecido (eu penso)– É evidente que (eu penso)– Não há duvida (estou convencido)– É provável (não tenho provas

suficientes)– Como sabe (supérfluo)– Como foi mencionado anteriormente (supérfluo)

Forma: Palavras– cidadão médio utiliza cerca de 1500 palavras– cidadão culto trabalha com cerca de 5000 palavras– evitar palavras pouco comuns– evitar palavras ambíguas (ex., etc.)– evitar a qualificação desnecessária (ex.,

informação válida e informação)– utilizar o número mínimo de palavras (ex., chegar

a uma decisão e decidir)– Gunning fog index:

http://en.wikipedia.org/wiki/Gunning-Fog_Index

Forma: Pontuação

– vírgulas• utilizar antes de uma conjunção no meio de um

período excepto quando as frases são curtas• utilizar após palavras introdutórias

– i.e., Near a small stream at the bottom of the canyon, we discovered an abandoned shelter

• utilizar entre items numa série• utilizar para destacar nomes, as palavras sim e

não e interjeições• utilizar em datas, endereços e títulos

Forma: Pontuação

– Ponto e vírgula• utilizar para separar frases relacionadas mas

independentes– In matters of principle, stand like a rock; in matters of

taste, swim with the current

• utilizar para separar items numa série que tem pontuação interna

Forma: Mecânica

– Usar maiúsculas em nomes próprios – Estuário do Tejo

– Clarificar acrónimos– Association of Computing Machinery (ACM)

– Escrever por extenso números que requeiram uma ou duas palavras (oito em vez de 8). Utilizar números para números que requeiram mais de duas palavras (176 em vez de cento e setenta e seis)

– Evitar erros ortográficos

Forma: Mecânica

– Ilustrações• apresentar no texto (i.e., ver Fig. 1)• inserir após apresentação• legendar na parte inferior (figuras) e no topo

(tabelas)

Forma: Mecânica

• Referências– Introduzir no texto

• Silva e Silva, 1986• utilizar et al. para mais de três autores

– Artigos em revistas• nome dos autores, data, título do artigo, título

da revista, volume, número, páginas

Forma: Mecânica

• Referências (cont.)

– capítulos em livros• nomes dos autores, data, título do artigo, título

do livro, autores do livro, editora, local de edição, páginas

– livros• autores, data, título, editora, local de edição

Forma: Mecânica

• Referências (cont.– em actas de conferências

• nome do autor, data, título da comunicação, in título das actas da conferência, local e data da conferência, sociedade científica, páginas

• Sigam um estilo e sejam coerentes – Por exemplo APA style

http://owl.english.purdue.edu/owl/resource/560/01/

Plágio

• Quando se usa material criado por outros sem atribuir o crédito suficiente

• Se usarem frases escritas por outros devem usar aspas ou itálico e incluir referência

• Se rescreverem textos de outros devem incluir referencias

Processo da Escrita

• Ganhar disposição• Escrever o primeiro draft• Rever editar rever editar rever editar….• Acabamentos• Dica: Olhem para bons exemplos

Recursos

• MIT Online writing Center: http://web.mit.edu/writing/

• Nasa Technical Report Writing http://grcpublishing.grc.nasa.gov/editing/vidoli.CFM

• ViTECH writing center http://www.writing.eng.vt.edu/

• Escrita de propostashttp://www.captureplanning.com/articles/92141.cfm?