Guia Prático para Relatórios, Propostas, Artigos, Teses, Livros, Políticas, Procedimentos e Documentos Breves
Guia Prático para Relatórios, Propostas, Artigos, Teses, Livros, Políticas, Procedimentos e Documentos Breves FERNANDO BOAVIDA MÁRIO BERNARDES ✒
Fernando Boavida Mário Bernardes
www.pactor.pt
Reservados todos os direitos, incluindo os de reprodução total ou parcial em qualquer formato ou de suporte e base de dados, quaisquer que sejam os seus objetivos, sem prévia autorização expressa por escrito da Editora.
EDIÇÃO
PACTOR – Edições de Ciências Sociais, Forenses e da Educação
ISBN edição impressa: 978-989-693-181-0 1.ª edição impressa: agosto de 2024
Paginação: Carlos Mendes
Impressão e acabamento: Tipografia Lousanense, Lda. – Lousã
Depósito Legal n.º 536154/24
Capa: José Manuel Reis
Todos os nossos livros passam por um rigoroso controlo de qualidade, no entanto, aconselhamos a consulta periódica do nosso site (www.pactor.pt) para fazer o download de eventuais correções.
Não nos responsabilizamos por desatualizações das hiperligações presentes nesta obra, que foram verificadas à data de publicação da mesma.
Os nomes comerciais referenciados neste livro têm patente registada.
Reservados todos os direitos. Esta publicação não pode ser reproduzida, nem transmitida, no todo ou em parte, por qualquer processo eletrónico, mecânico, fotocópia, digitalização, gravação, sistema de armazenamento e disponibilização de informação, sítio Web, blogue ou outros, sem prévia autorização escrita da Editora, exceto o permitido pelo CDADC, em termos de cópia privada pela AGECOP – Associação para a Gestão da Cópia Privada, através do pagamento das respetivas taxas.
3.6
3.6.1
3.7.5
3.8
5.3
4.2.3
INTRODUÇÃO
Vivemos num mundo fortemente tecnológico, no qual é cada vez mais importante explicar, quer oralmente quer por escrito, todo o tipo de ideias, abordagens, produtos ou soluções. Neste contexto, saber escrever documentos de natureza técnica é fundamental. De facto, mesmo que nunca se venha a escrever um documento desse tipo, perceber a forma como estão organizados é essencial para uma melhor compreensão e para maximizar o partido que deles se tira. Existem muitos tipos de documentos técnicos. Quase todos os cursos de nível médio ou superior exigem a escrita de uma dissertação final ou tese. As revistas científicas ou técnicas, nas mais variadas áreas do saber, são compostas por artigos que nos explicam ideias, propostas, teorias, processos ou soluções inovadoras, contribuindo para o avanço do conhecimento e da sociedade em geral. Ao longo da nossa vida académica ou profissional, muitos serão os relatórios que teremos de elaborar, descrevendo aquilo que foi feito, reportando problemas e propondo formas de os ultrapassar. Noutros casos, teremos de elaborar propostas, que serão avaliadas por chefias e decisores, e que ditarão atividades, desenvolvimentos, ou investimentos futuros. Todos estes documentos são essenciais para a sociedade atual, o que confere à escrita técnica um papel determinante para organizações, empresas e respetivos profissionais. Nos dias de hoje, pode dizer-se que muito do sucesso pessoal e profissional passa pela capacidade de escrever documentos de natureza técnica de forma clara e eficaz.
Neste capítulo introdutório, começa-se por detalhar a motivação e o âmbito do presente livro. De seguida, explicam-se os seus objetivos, bem como a abordagem adotada para os atingir, e identifica-se o público-alvo. Por fim, descreve-se a estrutura que foi utilizada na elaboração dos capítulos, fazendo-se uma breve introdução a cada um deles.
MOTIVAÇÃO E ÂMBITO
Como se deve organizar o processo de escrita de um documento técnico? Que aspetos devem ser tidos em conta na sua preparação? Como deve
ser estruturado um documento técnico? Quais as fases de escrita e de revisão do documento? Que tipos de documentos técnicos existem? Como escrever um relatório técnico, um relatório de estágio ou um relatório de atividades? Como elaborar um relatório de progresso de um projeto? Qual a diferença, em termos de abordagem, entre um relatório de progresso e um relatório final? Que aspetos devem ser realçados num e noutro tipo de relatório? Como se deve organizar e escrever uma proposta de projeto? Quando se pretende lançar um estágio, o que deve ser considerado na escrita do anúncio? Se tencionamos atribuir um dado financiamento, como se deve conceber o documento de chamada de propostas? O que é uma dissertação de mestrado e como deve estar organizada? Como escrever uma dissertação de mestrado? O que é uma tese de doutoramento e como deve estar estruturada? Como redigir uma tese de doutoramento? Qual a melhor forma de organizar e escrever um livro técnico? Como estruturar um artigo científico ou técnico? O que incluir em cada secção de um artigo científico ou técnico? Como elaborar um documento de apresentação do estado da arte numa dada área? Quando organizamos uma conferência, como se deve organizar e escrever o documento de chamada de artigos para a conferência? Como organizar e escrever documentos breves como memorandos, pareceres, cartas de recomendação, folhetos ou mensagens de correio eletrónico? Como elaborar um manual técnico? Como escrever um documento de definição de procedimentos? O que é e como escrever um documento de definição de políticas? Que ferramentas são utilizadas em escrita técnica? O que é um sistema de documentação e quais os seus requisitos? A resposta a estas e a várias outras questões relacionadas é a principal motivação para o presente texto.
Existem várias ferramentas e tecnologias, quer de domínio público quer de fabricantes específicos, para a elaboração e escrita de todo o tipo de documentos, incluindo, naturalmente, documentos de natureza técnica, sejam eles em papel, em formato digital, ou para visualização em linha. Em geral, todas essas ferramentas são extremamente sofisticadas, com enorme potencial de utilização em todas as fases da escrita, desde a preparação inicial à realização final. Quando utilizadas corretamente, torna-se relativamente fácil construir documentos apelativos, que impressionam pela sua qualidade gráfica, pelos efeitos que utilizam, ou pela grande variedade de
elementos que podem incluir – sejam eles textuais, gráficos ou audiovisuais. Apesar disso, muitas pessoas desconhecem como organizar e escrever um documento de natureza técnica, de forma a cativar o leitor e a passar uma mensagem clara. Muitos são os casos de relatórios que ninguém lê, de propostas de projeto recusadas, de pedidos de financiamento que falham, de teses ou artigos recusados ou mal avaliados, de pareceres ineficazes ou de documentação técnica ignorada porque os autores não conseguiram explicar os seus objetivos e as suas vantagens. Tudo isto se reflete no sucesso (ou insucesso) de muitos profissionais que, sendo competentes na sua área de especialidade, descuram a importância e o impacto de uma eficaz comunicação escrita.
Quais os motivos que justificam esta situação? As razões são variadas. Em primeiro lugar, as ferramentas e tecnologias, por si só, não podem resolver um problema que é, essencialmente, de conteúdo e não de forma. Podemos e devemos explorar as ferramentas existentes, tirar partido das tecnologias, mas, se não o fizermos corretamente, estas só servirão para acentuar aquilo que é evidente: a incapacidade para identificar, expor e transmitir as ideias-chave, a mensagem que queremos passar a outros. De nada adianta ter as ferramentas se não sabemos o que queremos e se não as sabemos utilizar para atingir os fins em vista. Nesta matéria, em muitos casos, as tecnologias servem para nos desviar do nosso propósito, para camuflar um caminho já de si pouco claro e objetivo, para tornar a mensagem mais errática, mais diluída e mais difusa. E isso é, precisamente, o oposto daquilo que se deseja quando escrevemos um documento técnico, que se pretende o mais claro e objetivo possível. É completamente errado pensar que um bom documento técnico tem de ser constituído por elementos que transbordam com dados e objetos gráficos de todo o tipo, que, apesar de mostrarem um grande domínio da ferramenta utilizada, falham estrondosamente como veículo da mensagem essencial. Mais do que em qualquer outro tipo de documento, os documentos técnicos ou científicos devem transmitir ideias ou mensagens sem ambiguidade e, para tal, devem ser cuidadosamente estruturados e escritos, privilegiando-se a clareza em toda a sua extensão.
A motivação deste livro é, por isso, a seguinte: identificar as estratégias mais adequadas para a elaboração de um leque representativo de documentos técnicos, desde a sua conceção inicial até à versão final, passando pelas suas diversas fases intermédias, que incluem a estruturação, a escrita e as revisões.
Deve, no entanto, clarificar-se o âmbito do livro. Não se pretende aqui apresentar um extenso manual de escrita técnica ou científica para a elaboração de todo o tipo de documentos, de entre a longa lista de textos deste tipo. Tampouco se pretende detalhar o uso de qualquer ferramenta específica, além do cérebro humano, nem abordar questões de linguagem ou explicar as diversas formas para argumentação e/ou raciocínio crítico. O âmbito deste texto é muito mais restrito e pragmático: explicar como documentar, apresentar ou expor, de forma escrita, uma ideia ou um conjunto limitado de ideias de natureza técnica ou científica, abrangendo um número frequente de casos, como sejam a elaboração de relatórios ou propostas, a escrita de dissertações e teses, livros ou artigos, ou a descrição de procedimentos e políticas.
OBJETIVOS E ABORDAGEM
A escrita de documentos técnicos como relatórios, propostas ou pareceres é essencial para um número crescente de pessoas, pois disso pode depender uma boa parte do sucesso pessoal e profissional. Estamos constantemente a comunicar com outros e a expor ideias através de documentos escritos. Se não o soubermos fazer eficazmente, arriscamo-nos a perder oportunidades, não alcançar objetivos e fracassar, independentemente de as nossas ideias ou propostas serem melhores do que as de outras pessoas. De facto, poderá dizer-se que as ideias que sobrevivem não são, necessariamente, as melhores, mas sim as que são mais bem expostas ou apresentadas.
São objetivos do presente livro a identificação, análise e discussão dos aspetos essenciais das diversas estratégias e abordagens para a exposição escrita de ideias em documentos técnicos. Esses elementos incluem todas
as fases do processo de escrita deste tipo de documentos, começando pela preparação inicial, a que se seguem a definição da estrutura, a identificação dos conteúdos a colocar em cada secção, a escrita e a revisão final. Complementarmente, também são brevemente identificados ferramentas, suportes e sistemas de documentação. Trata-se, portanto, de um texto abrangente, mas sem pretensões de formalismos teóricos, que fornece uma visão global dos diversos passos a ter em conta e a executar sempre que pretendemos escrever um documento de natureza técnica.
Pretende-se, desta forma, não só introduzir o leitor às estratégias e formas de exposição escrita de ideias, mas também definir e explicar os passos para a construção de documentos cativantes, bem estruturados e que cumpram o objetivo de veicular ideias que perdurem e que vençam, contribuindo, assim, para maximizar as hipóteses de sucesso individual e de equipas.
Este livro aborda a redação de um leque de documentos técnicos mais comuns, de uma forma inovadora e “refrescante”, pesando os seus diversos ângulos e considerando muitos dos seus detalhes. A obra abrange não só abordagens consolidadas e bem conhecidas por especialistas, mas também aproximações e técnicas desenvolvidas pelos autores ao longo das suas carreiras profissionais, envolvidos em atividades de ensino, investigação, engenharia e gestão que, naturalmente, exigiram a escrita de muitas centenas de documentos de natureza técnica ou científica.
Nos capítulos 1 a 4, os conceitos, as estratégias e as aproximações são apresentados e analisados com a profundidade necessária à sua compreensão, de forma que o leitor perceba os problemas e as respetivas abordagens. Complementarmente, no final de cada um dos referidos capítulos é apresentada uma síntese das principais ideias do capítulo, seguida de um conjunto de exercícios cujo principal objetivo é o de, por um lado, consolidar os conceitos apresentados ao longo do capítulo e, por outro, levar o leitor a pôr essas noções em prática no seu caso particular. O Capítulo 5 apresenta um conjunto de considerações finais que, no seu todo, constitui não só as conclusões de toda a argumentação apresentada ao longo do livro, mas também as linhas orientadoras para uma eficaz e bem-sucedida exposição escrita de ideias em documentos técnicos.
O livro destina-se a todo o tipo de público, desde aqueles que nada sabem sobre exposição escrita de ideias em documentos de natureza técnica e/ou creem que nunca necessitarão dessas competências, até aos que acreditam que já muito sabem sobre este tema, passando, naturalmente, pelos que reconhecem as suas limitações e consideram que necessitam de saber mais sobre o assunto. Podem beneficiar especialmente deste livro todo o tipo de profissionais, trabalhando individualmente ou em equipa, que tenham a necessidade de expor as suas ideias por escrito, apresentar propostas ou comunicar resultados do seu trabalho, incluindo, entre muitos outros, cientistas, investigadores, engenheiros, economistas, gestores, jornalistas, políticos, professores de todos os graus de ensino e, ainda, estudantes. Também podem beneficiar deste livro aqueles que nunca escreverão nenhum documento técnico, mas que, muito provavelmente, terão de os ler ao longo da sua carreira. Para esses, esta obra permitirá perceber melhor o que leem e identificar facilmente a respetiva mensagem.
ORGANIZAÇÃO DO LIVRO
Além da Introdução, na qual se apresentam as motivações, o âmbito, os objetivos, a abordagem e o público-alvo, o livro é composto por cinco capítulos que versam, sucessivamente, sobre os objetivos e as áreas da escrita técnica, a preparação e organização do processo de escrita, a estruturação e escrita de diversas classes de documentos técnicos ou científicos, os principais aspetos a considerar na gestão de documentação, e as linhas orientadoras para a escrita técnica.
O Capítulo 1 – intitulado “Aspetos gerais da escrita técnica” – é um capítulo de enquadramento que explica a importância da escrita técnica nos nossos dias, os seus objetivos e as principais áreas. Fornece, também, vários exemplos de documentos técnicos, discute algumas questões de forma e identifica ferramentas comummente utilizadas na elaboração deste tipo de documentos.
Depois de estabelecidos o âmbito, a natureza, a aplicabilidade e a importância da escrita técnica no Capítulo 1, o Capítulo 2 – “Fases de preparação
e escrita” – apresenta e discute a abordagem geral subjacente ao processo de escrita técnica, que compreende uma fase de preparação inicial e uma fase de escrita propriamente dita. Inicialmente, definem-se o tipo, a área, o objetivo e o âmbito do documento. Seguidamente, identificam-se o público-alvo e os tipos de suporte, acesso e distribuição do documento. Os passos seguintes incluem a identificação da equipa responsável pela elaboração do documento, definição da estrutura, organização gráfica e calendarização.
O Capítulo 3 – “Documentos técnicos” – é o capítulo central do livro, em que se aborda o processo de escrita de um conjunto significativo de documentos de natureza técnica ou científica, num total de 22 tipos diferentes de documentos. Para cada uma dessas tipologias, apresentam-se os objetivos, descreve-se a respetiva estrutura genérica, identificam-se os conteúdos-chave a incluir em cada secção e explica-se a abordagem a adotar no processo de escrita.
O Capítulo 4 – “Gestão da documentação” – complementa o anterior, ao abordar aspetos-chave na gestão de documentação técnica, incluindo produção de documentação, armazenamento e recuperação, pesquisa de informação, acessibilidade e controlo de acesso, e arquivo e preservação. Este capítulo inclui também algumas soluções para gestão da produção de documentação.
Por fim, o Capítulo 5 – “Notas finais” – é dedicado à apresentação de um conjunto de recomendações finais, consolidando, em termos gerais, os diversos aspetos e abordagens analisados ao longo do livro.
Tal como referido na secção “Objetivos e abordagem”, no final de cada um dos capítulos 1 a 4 é feito um resumo dos temas abordados e proposto um conjunto de exercícios de aplicação dos conceitos aí apresentados.
No final do livro, encontra-se, ainda, a bibliografia utilizada, que poderá servir como complemento aos temas abordados.
Capítulo 1
ASPETOS GERAIS DA ESCRITA TÉCNICA
Apesar de normalmente se considerar que a escrita técnica é algo relativamente recente, a verdade é que os primeiros documentos desta natureza remontam a Aristóteles e ao seu tempo. Leonardo da Vinci e Isaac Newton são exemplos mais recentes de inventores/cientistas que elaboraram múltiplos documentos técnicos ou científicos. Mas foi o desenvolvimento tecnológico que se seguiu à Segunda Guerra Mundial que levou a um enorme incremento dos documentos de natureza técnica. Nos dias de hoje, a documentação técnica ou científica desempenha um papel essencial na sociedade, sendo o suporte para um sem-número de atividades em todas as áreas.
O objetivo deste capítulo é o de apresentar, de forma genérica, as principais questões a considerar neste tipo de escrita, que serão aprofundadas nos capítulos posteriores. Após a identificação da necessidade da escrita técnica, descrevem-se as suas principais características. Apresenta-se, seguidamente, o ciclo de vida dos documentos técnicos e fornecem-se vários exemplos de documentação técnica. Posteriormente, são elaboradas algumas considerações sobre formatação e identificados alguns tipos de ferramentas utilizadas na elaboração de documentos técnicos. O capítulo termina com um breve resumo das ideias apresentadas e uma proposta de vários exercícios.
1.1 NECESSIDADE
Estamos constantemente a ser solicitados para escrever ou ler documentos de natureza técnica, quer no contexto da nossa atividade profissional quer, até, em contexto pessoal. Nenhuma empresa funciona sem documentação. Por um lado, é frequente a necessidade de reportar o estado de projetos, iniciativas ou atividades. Por outro, em muitos casos, haverá que submeter propostas de projetos, sejam eles internos ou envolvendo outras entidades, cujo financiamento poderá ser determinante para a empresa. Além disso, poderá existir a necessidade de expor novas ideias, de explicar as soluções existentes numa dada área ou de elaborar manuais de utilização de produtos ou serviços. Não menos importante é a definição da organização
interna, ou de procedimentos ou políticas a adotar em toda a instituição, o que determinará as formas de atuação de todos os seus membros. Já em ambiente académico ou de formação, são inúmeras as situações nas quais é necessário elaborar um relatório, escrever um artigo técnico ou científico, ou escrever uma dissertação de mestrado ou tese de doutoramento. Todas estas atividades requerem a elaboração de documentação de natureza técnica ou científica que, no contexto deste livro, designaremos apenas por “documentação técnica”.
A escrita de documentos de natureza técnica ou, simplesmente, a escrita técnica aplica-se a praticamente todas as áreas de atividade e do saber, embora normalmente se associe a áreas como a engenharia e as ciências ditas exatas. Como exemplos, referem-se a engenharia informática e de computadores, a engenharia eletrotécnica, a engenharia civil, a química, a física, a aeronáutica, a robótica, a biotecnologia ou a medicina. No entanto, aplica-se também a áreas como as finanças e as humanidades. Em geral, sempre que seja necessário expor ideias, relatar atividades ou documentar produtos, sistemas ou ações ter-se-á de elaborar algum tipo de documentação técnica.
A escrita técnica assume, assim, um papel central e crítico na sociedade atual, pelo que é fundamental conhecer e dominar este tipo de escrita. Alguém com capacidade para redigir bem este tipo de documentos tem, claramente, fortes vantagens em relação a uma pessoa que seja incapaz de o fazer. Por outro lado, é essencial, também, saber ler este tipo de documentos, para deles poder extrair a informação relevante. Independentemente do ponto de vista – seja ele o de quem escreve ou o de quem lê –, a escrita técnica tem de assentar num pressuposto fundamental: a clareza.
Além da clareza, um bom documento técnico tem de ser útil, rigoroso e disponível. São estas quatro características, representadas na Figura 1.1, que devemos procurar num documento. Abordaremos as mesma na próxima secção, além de estarem subjacentes a todo o livro.
Capítulo 2 FASES DE PREPARAÇÃO E ESCRITA
Como vimos no capítulo anterior, as duas fases mais dinâmicas do ciclo de vida de um documento técnico são a fase de preparação e a fase de escrita. É delas que depende a qualidade do documento final e, portanto, a sua clareza, utilidade, rigor e disponibilidade. Justifica-se assim que, antes de passarmos a identificar, analisar e discutir a organização e conteúdos de vários tipos de documentos técnicos – o que faremos no Capítulo 3 –, dediquemos um capítulo a detalhar os processos de preparação e escrita dos documentos técnicos em geral. É esse o objetivo do presente capítulo.
Assim, após uma breve introdução, realizada na secção da Introdução, descrevem-se, na secção 2.1, as diversas atividades a realizar na fase de preparação, como a definição do objetivo e âmbito do documento, a identificação do público-alvo, a escolha das formas previstas para disponibilização do documento, a constituição da equipa de escrita e respetivas tarefas, a definição da estrutura do documento, a escolha do desenho gráfico geral, e o estabelecimento do calendário para todo o projeto. Na secção 2.2, aborda-se a fase de escrita, composta, no essencial, pela escrita de rascunhos e respetiva revisão técnica. Tal como nos outros capítulos, este termina igualmente com um resumo dos tópicos abordados e a proposta de um conjunto de exercícios.
2.1 INTRODUÇÃO
Muitos pensam que o sucesso de qualquer atividade depende, em grande medida, da forma de execução, mas qualquer especialista sabe que é a preparação que dita o resultado final. A escrita de documentos técnicos não é exceção a esta regra.
Muito antes de se iniciar o processo de escrita, há que definir e organizar todo o projeto. De facto, a escrita de um documento técnico com alguma complexidade deve ser encarada como a realização de um projeto, ao qual estão associados objetivos, meios, equipa, responsabilidades, fases e calendarização. Não passaria pela cabeça de ninguém iniciar um projeto sem
que tais aspetos fossem definidos, pelo que tal também deve acontecer no caso da escrita de documentos técnicos. Só uma preparação cuidada permite maximizar a probabilidade de todos os objetivos serem alcançados. Por outro lado, a ausência de preparação é o primeiro passo para um muito provável fracasso.
Naturalmente, nem todos os tipos de documentos necessitam do mesmo grau de preparação. Documentos de grande complexidade, importância ou extensão exigirão sempre uma preparação muito cuidada. Porém, os documentos simples, como memorandos, pareceres, cartas de recomendação, folhetos ou mensagens de correio eletrónico, não deixam de exigir cuidado na sua elaboração, mas algumas das etapas preparatórias poderão ser encurtadas ou mesmo omitidas. À medida que a experiência do autor dos documentos técnicos vai aumentado, certas etapas poderão ser executadas de forma quase automática ou, até, mentalmente.
Após uma adequada preparação, pode dar-se início à fase de escrita. Em regra geral, qualquer documento técnico passa pela elaboração de vários rascunhos e subsequente revisão técnica. É extremamente importante que, entre a formulação de um rascunho e a revisão técnica, exista algum distanciamento. Havendo uma equipa de edição, isso pode conseguir-se escolhendo revisores que não tenham estado envolvidos na escrita do rascunho. Se o documento estiver a ser elaborado por uma única pessoa, o distanciamento consegue-se de forma temporal. Assim, deve decorrer algum tempo entre a escrita do rascunho e a revisão e, idealmente, durante esse intervalo de tempo o autor deverá envolver-se numa atividade completamente distinta, seja ela laboral ou de descanso. Em qualquer situação, poucos serão os casos em que um documento é escrito numa única iteração.
Dada a importância das fases de preparação e escrita, as próximas secções abordarão, em detalhe, cada uma destas fases. Os conceitos descritos neste capítulo aplicam-se, de forma genérica, a todos os tipos de documentos alvo de descrição no Capítulo 3, razão pela qual são previamente apresentados e discutidos aqui.
Capítulo 3
DOCUMENTOS TÉCNICOS
No capítulo anterior, apresentámos e discutimos as diversas etapas das duas primeiras fases do ciclo de vida dos documentos técnicos, nomeadamente a fase de preparação e a fase de escrita. Estabelecidos os princípios e as abordagens a adotar nessas fases, importa agora concretizá-los para vários tipos frequentes de documentos, apresentando estruturas e identificando conteúdos típicos para cada componente dessas estruturas. Desta forma, este capítulo apresentará soluções modelo, que poderão ser usadas como ponto de partida ou como guia para documentos concretos, à exceção de eventuais adaptações específicas para cada caso.
São apresentadas estruturas genéricas para 22 tipos de documentos, organizados em seis secções. Na secção 3.1, são abordados cinco tipos distintos de relatórios, a saber, relatórios técnicos, relatórios de estágio, relatórios de atividades, relatórios de projeto e, ainda, curriculum vitae. A secção 3.2 é dedicada à escrita de chamadas e de propostas, sejam elas chamadas de projeto, propostas de projeto ou chamadas de estágio. A escrita de artigos é tratada na secção 3.3, abrangendo artigos científicos, artigos técnicos, visões do estado da arte ou, ainda, chamadas de artigos para conferências ou congressos. A secção 3.4 debruça-se sobre a escrita de dissertações de mestrado, teses de doutoramento e livros técnicos. A secção 3.5 ocupa-se da escrita de documentos de definição de políticas e documentos de definição de procedimentos. A secção 3.6 é dedicada a um leque de documentos breves, nomeadamente, memorandos, pareceres, cartas de recomendação, folhetos e mensagens de correio eletrónico. No final do capítulo, sintetizam-se as ideias apresentadas e propõe-se um conjunto de exercícios de aplicação.
3.1 INTRODUÇÃO
Uma vez que o objetivo, o âmbito e o público-alvo dos diversos tipos de documentos técnicos podem ser muito diversos – o que se refletirá quer na respetiva estrutura quer nos conteúdos –, não se pode aplicar uma “receita” única para a sua escrita. A definição de diferentes estruturas e conteúdos típicos para relatórios, propostas, artigos técnicos ou científicos,
pretende passar, isto é, com os resultados e/ou recomendações que servirão de ponto fulcral para a tomada de decisões.
3.2.2 Relatório de estágio
São muito frequentes os casos em que determinada entidade ou empresa promove ou acolhe um estágio profissional. Trata-se de iniciativas muito importantes, que possibilitam a formação ou requalificação em contexto laboral, de forma complementar à formação anterior, tenha ela sido meramente académica ou tenha já incluído alguma atividade profissional. Além disso, os estágios profissionais são, em muitos casos, formas eficazes de promoção do emprego.
Normalmente, a finalização do estágio acarreta a escrita de um relatório por parte do formando ou pelo seu orientador, sobretudo se se tratar de um estágio financiado por uma entidade externa que, tipicamente, é estatal. Tratando-se de um documento técnico bastante frequente, revela-se pertinente incluir neste livro algumas orientações para a sua elaboração.
De notar que este tópico está relacionado com o que será abordado na secção 3.2.3, embora aqui a perspetiva seja a de quem realizou o estágio e naquela secção seja a de quem anuncia a abertura de candidaturas a estágio. A Figura 3.5 apresenta a estrutura lógica de um relatório de estágio.
Enquadramento
• Área
• Objetivos
• Abordagem/Metodologia
Trabalho realizado
• Plano (inicial e final)
• Tarefas
• Resultados
Resultados
• Competências adquiridas
• Balanço (análise crítica)
• Perspetivas
FIGURA 3.5 – ESTRUTURA LÓGICA DE UM RELATÓRIO DE ESTÁGIO
Tal como se depreende da figura, este tipo de relatório tem três grandes componentes: apresentação do enquadramento do estágio, descrição do trabalho realizado, e discussão dos resultados alcançados.
No enquadramento, caracteriza-se a área na qual se insere o estágio, listam-se os seus objetivos e apresenta-se a abordagem e/ou metodologia que foi seguida para a sua realização. Os objetivos aqui descritos decorrem diretamente dos que foram estabelecidos no documento de proposta de estágio. Caso existam diferenças, estas devem ser devidamente justificadas.
A parte central do relatório deve incidir sobre o trabalho realizado, descrevendo-se o plano inicialmente previsto e eventuais alterações, as tarefas que foram executadas e os respetivos resultados. Também aqui o plano deve ter uma correspondência com o que foi definido na proposta, devendo ser fundamentadas quaisquer alterações.
A terceira componente é dedicada à apresentação dos resultados globais do estágio, nomeadamente as competências adquiridas. Poder-se-ão, ainda, incluir nesta componente uma análise crítica e a identificação de perspetivas para futuros trabalhos.
Esta estrutura lógica permite-nos, desde logo, definir um ponto de partida para a estrutura física genérica de um relatório de estágio, apresentada na Tabela 3.2. Naturalmente, trata-se de uma estrutura tipo, que deverá ser adaptada a cada caso concreto.
– ESTRUTURA TIPO DE UM RELATÓRIO DE ESTÁGIO
Secção
Página de rosto
Sumário
Descrição
• Título, autor, afiliação e data do relatório.
• Entidade promotora e entidade acolhedora do estágio.
• Visão breve e geral do relatório, que poderá ser utilizada para divulgação.
• Deve explicar de forma muito sucinta e abstrata o objetivo do estágio, o trabalho realizado e os resultados alcançados.
(continua)
TABELA 3.2
(continuação)
Secção
Índice
Listas complementares (opcional)
Introdução
Corpo
Conclusão
Referências
Agradecimentos
Apêndices (opcional)
Descrição
• Lista hierárquica de capítulos, secções e subsecções que compõem o documento, com indicação das respetivas páginas de início.
• No caso de relatórios com apenas algumas páginas, poderá não existir.
Em relatórios com alguma extensão, poderá ser fornecido um índice de figuras, um índice de tabelas, glossário e lista de acrónimos.
• Apresentar a área e a motivação do estágio.
• Opcionalmente, poder-se-á evidenciar o contexto de realização do estágio.
• Identificar os objetivos do estágio.
• Explicar a abordagem e metodologia utilizadas.
• Descrever a organização do documento.
Um ou mais capítulos e secções, apresentando:
• Plano de trabalho (inicial e final);
• Descrição das tarefas realizadas e dos respetivos resultados.
• Identificação e discussão das competências adquiridas.
• Análise crítica (dificuldades, desafios, ganhos e vantagens).
• Perspetivas de trabalho futuro.
Identificação dos documentos utilizados como fonte e citados no corpo do documento.
Reconhecimento de apoios, quer de pessoas, quer de instituições.
• Informação complementar, eventualmente de grande extensão, que suporta a informação mais sucinta e organizada incluída no corpo do documento.
• Código ou programas computacionais.
• Especificações detalhadas.
ÍNDICE REMISSIVO
A
Acessibilidade, 27
Agregação de documentos, 163
Âmbito, 24
Análise SWOT, 65, 69
Apresentação do enquadramento do estágio, 56
Arquitetura geral, 85
Arquivo, 28, 168
Artigos, 10, 101 científicos, 101 técnicos, 105
Atualizações, 8
Autenticação de utilizadores, 166
Autorização de acesso, 166
Aviso de abertura do concurso, 79, 80
B
Backup, 161
Blogs, 170
C
Call for papers, 111
Características, 5
Cartas de recomendação, 140
Chamada de estágio(s), 78, 99 de projetos, 78
Ciclo de vida dos documentos técnicos, 6
Classificação dos documentos, 164
Cloud services, 161
Conclusão, 54
Controlo de versões, 8, 14
Corpo do relatório técnico, 54
Curriculum vitae (CV), 71 orientado para uma área empresarial, 74 um trabalho de natureza científica, 74
D
Defesa intermédia, 115
Descrição do trabalho realizado, 56
Diagrama de Gantt, 87
Discussão dos resultados alcançados, 56
Dissertação(ões) de desenvolvimento (D), 114 de investigação e desenvolvimento (I&D), 114 de investigação (I), 114 de mestrado, 11, 113 intermédia, 115
E
Edição colaborativa, 160 de imagem, 14
Quer aprender a organizar o processo de escrita de um documento técnico? Quer expor por escrito, de forma clara e objetiva, as suas ideias? E entender melhor os documentos técnicos que lê? Então este livro é para si!
A escrita de documentos técnicos como relatórios, propostas, artigos, teses ou pareceres é essencial para todas as pessoas, pois disso pode depender uma boa parte do seu sucesso pessoal e pro ssional. Estamos constantemente a comunicar com outros e a expor ideias através de documentos escritos, e se não o soubermos fazer e cazmente arriscamo-nos a perder oportunidades, a não alcançar objetivos e a fracassar.
Surge então o presente livro, que tem como nalidades a identi cação, análise e discussão dos aspetos essenciais das diversas estratégias e abordagens para a exposição escrita de ideias em documentos técnicos, dando também as ferramentas necessárias para um melhor entendimento da documentação técnica.
Este livro é destinado a todo o tipo de pro ssionais que, trabalhando individualmente ou em equipa, tenham a necessidade de expor as suas ideias na forma escrita, apresentar propostas ou comunicar resultados do seu trabalho, incluindo, entre muitos outros, cientistas, investigadores, engenheiros, economistas, gestores, jornalistas, políticos, professores de todos os graus de ensino, e, ainda, os estudantes.
www.pactor.pt
COM ESTE LIVRO APRENDA A:
Expor melhor, por escrito, as suas ideias, aumentando as probabilidades de sucesso;
Planear, projetar e estruturar um grande leque de documentos técnicos; Comunicar de forma e ciente e e caz;
Cativar os leitores dos documentos que elabora; Ler mais facilmente, entender melhor e avaliar os documentos técnicos que lê; Perceber as formas, ferramentas e fases da gestão de documentos técnicos.
