Você está na página 1de 9

Documentação técnica

Clareza, coerência, objetividade, ordenação lógica, correção gramatical. Essas são algumas
características de todo bom texto. Com o texto de uma documentação técnica não é diferente.
Quando você for escrever seu relatório, por exemplo, vai ter de levá-las em consideração. É por
isso que vamos estudar cada uma delas em detalhe. Mas, antes, vamos explicar o que é uma
documentação técnica. Acompanhe!
A documentação técnica é um texto preparado para tratar de assuntos ou fatos técnicos ou
científicos.
Podemos citar como tipos de documentação técnica: os relatórios, as normas, as instruções,
o parecer técnico. Todos esses documentos utilizam a estrutura do texto técnico na sua elabo-
ração. Neste capítulo, vamos nos ater ao relatório, pois essa atividade faz parte do dia a dia de
muitos técnicos e pode vir a fazer parte de sua rotina profissional também. Por isso, estude bem
o conteúdo deste capítulo.

7.1 TEXTO TÉCNICO

Vamos ver, agora, algumas características do texto técnico.

Clareza – a falta de clareza é o que impede o entendimento do texto em uma primeira lei-
tura. É necessário repeti-la várias vezes para entender o que o autor está propondo. Podemos
garantir a clareza do texto com alguns recursos bem simples. Observe!
a) Construa frases na ordem direta (A solda (sujeito) está (verbo) em boas condições (com-
plemento).
b) Apresente as informações em uma sequência lógica.
c) Indique cada procedimento em um parágrafo distinto.
COMUNICAÇÃO ORAL E ESCRITA
76

Foco no leitor – identificar quem vai ler o relatório é importante para que pos-
samos definir os termos empregados. Antes de iniciar seu texto, procure respon-
der às seguintes questões:
a) o leitor conhece o assunto?
b) será lido pelos funcionários ou pelos diretores da empresa?
c) o relatório é para o público externo que pertence a uma categoria profis-
sional específica?
Após responder essas questões, você poderá selecionar as informações e iden-
tificar a melhor maneira de transmiti-las.

Formalidade – para escrever um texto técnico, não utilizamos linguagem


coloquial e, muito menos, gíria. Ao contrário, nosso texto é elaborado de acordo
com as regras da língua culta, que você já estudou no capítulo 2. É claro que isso
não quer dizer escrever de maneira complicada. Ao contrário, apesar de exigir
formalidade, você deve expressar suas ideias com palavras conhecidas.
Impessoalidade – o texto técnico tem como característica um certo distan-
ciamento entre o autor e o leitor, não admitindo subjetividade. Portanto, evite
utilizar expressões como “eu acredito que o processo...”, colocando em seu lugar
“entende-se que o processo...”
Objetividade – o texto técnico deve transmitir, sem rodeios, de uma forma
direta e clara, os fatos e os dados que o leitor precisa saber para chegar a uma
conclusão. Utilizar fotos, gráfico e tabelas é também uma forma de ser objetivo
nas suas informações. A organização dessas informações de maneira lógica e or-
denada é importante para o entendimento do conteúdo.

7.2 RELATÓRIO

O relatório é um tipo de documentação que serve, principalmente, para in-


formar, ensinar, orientar, relatar (daí o seu nome). Um relatório é a descrição feita
a partir de um fato, um acontecimento ou um fenômeno. Redigir esse tipo de
documento é uma atividade trabalhosa que deve ser feita com muita atenção.
O quê? Por quê? Quem? Onde? Quando? Como? Quanto? Quais as consequên-
cias? Algumas ou todas essas perguntas devem ser respondidas por um relatório
técnico bem elaborado. Mas, o mais importante é garantir que o relatório leve o
leitor a uma conclusão.
Para elaborar um relatório, é muito importante que as informações sejam bem
preparadas: o planejamento do texto e a escolha de seus gráficos e tabelas, por
exemplo. Em alguns casos, também é necessário indicar a bibliografia utilizada.
7 DOCUMENTAÇÃO TÉCNICA
77

O relatório é um documento utilizado pela administração para acompanhar


atividades desenvolvidas nos diversos setores de uma indústria, por exemplo. Ele
serve ainda para relatar a sequência de fatos relacionados a um evento específico,
como a inspeção de uma caldeira numa fábrica de eletrodomésticos ou o resul-
tado de uma pesquisa de satisfação feita entre os funcionários da administração
de uma empresa. Pode ainda ser utilizado para detalhar os passos de um procedi-
mento ou o funcionamento de um experimento ou de uma máquina.
É muito importante que o relatório traga a exposição de fatos em ordem cro-
nológica, bem como o detalhamento das atividades verificadas e, sempre que
possível, ele deve ser breve. Para tanto, você deve estar atento a sua estrutura,
isto é, às partes que o compõem. Essas partes são estabelecidas por normas da
Associação Brasileira de Normas Técnicas (ABNT). Veja, a seguir, algumas delas:
a) apresentação de trabalhos acadêmicos (NBR 14724);
b) referências (NBR 6023);
c) numeração progressiva (NBR 6024);
d) sumários (NBR 6027);
e) resumos (NBR 6028);
f ) índice (NBR 6034).

Fundada em 1940, a Associação Brasileira de Nor-


VOCÊ mas Técnicas (ABNT) é o órgão responsável pela
SABIA? normalização técnica (normas, especificações técnicas,
códigos de prática e regulamentos) no Brasil.

7.2.1 ESTRUTURA DO RELATÓRIO TÉCNICO

Mas você pode estar se perguntando: e qual a estrutura básica do relatório


técnico? O relatório deve ter as seguintes partes e, se possível, nesta ordem de
apresentação:
a) capa;
b) página de rosto;
c) sumário;
d) resumo;
e) introdução;
f ) desenvolvimento;
g) conclusão;
COMUNICAÇÃO ORAL E ESCRITA
78

1 ANEXOS h) agradecimentos;

São textos de outros


i) bibliografia;
autores que foram usados j) encerramento; e
no seu trabalho.
k) anexos1 e apêndices2.

2 APÊNDICES
Veja, no quadro a seguir, o que deve compor cada uma dessas partes.

São documentos
produzidos por você Quadro 6 - Partes constituintes do relatório
mesmo, mas que,
por sua extensão ou ITEM CONTÉM
complexidade, não cabem
Capa Título do trabalho, o nome do(s) autor(es) e a data.
no desenvolvimento do
relatório. Página de rosto Título do trabalho e nome do(s) autor(es).

Sumário Títulos e subtítulos das partes com os respectivos números da página.

Exposição sintetizada com a finalidade de transmitir uma ideia geral sobre


3 SUBTÍTULO Resumo
o trabalho.

É um título secundário, que Objetivo (sobre o que é o relatório).


se segue ao principal e o Introdução
Finalidade (para que será feito o relatório).
complementa, introduzindo
os diversos blocos em que é Método
dividido o texto. Descreve como aconteceu o evento (acidente, experiência, visita, estágio,
viagem). Descreve o processo (experiência, acidente, visita ou estágio).
Descreve o ambiente (visita, estágio).
Desenvolvimento Resultado
4 DIAGRAMAÇÃO Descreve o que se apurou, os resultados imediatos (acidente, experiência,
visita, estágio).
É o planejamento da Discussão
distância entre as linhas
do texto e a distribuição Analisa e argumenta o motivo do resultado obtido.
de títulos, subtítulos Conclusão Resposta à finalidade declarada na introdução.
e ilustrações (figuras,
quadros, tabelas) numa Agradecimentos Colaboração de pessoas, patrocínio ou subvenção, se houver.
página.
Bibliografia Relação de livros, revistas, enciclopédias, sites da internet pesquisados.

Anexos e Esclarecimento do assunto com a apresentação de gráficos, mapas e


desenhos. Devem aparecer no final do relatório, em folha separada e, se
apêndices necessário, com paginação própria.

A utilização de todos ou de alguns desses elementos vai depender da comple-


xidade das informações e da extensão do documento. Mas, é importante estru-
turar até os documentos mais simples, para que as informações sejam completa-
mente entendidas.
Os relatórios podem ser simples ou não, elaborados somente por você ou em
grupo, parciais ou completos, periódicos ou produzidos conforme a necessidade,
técnicos ou administrativos.
Desse modo, dependendo de suas características, eles podem ser classificados
como crítico, de síntese e de formação.
7 DOCUMENTAÇÃO TÉCNICA
79

Você pode escrever um relatório crítico, isto é, aquele que descreve como uma
atividade foi realizada, por exemplo, a inspeção de uma máquina. Nesse docu-
mento, você dará sua opinião.
Outro é o relatório de síntese, que resume um fato, uma experiência, uma situ-
ação. Esse documento pode ser elaborado a partir de outros relatórios.
Você pode ainda redigir um relatório documentando um curso ou um estágio.
Para esse documento, damos o nome de relatório de formação.

7.2.2 TIPOS DE RELATÓRIO

Os tipos de relatório podem ser: de atividade, de ocorrências e de estudo ou


pesquisa.
Para elaborar qualquer um deles, você deve utilizar e organizar suas partes
componentes. Além disso, não se esqueça de que um bom relatório deve ter ainda:
a) um título claro;
b) um sumário bem estruturado;
c) subtítulos3;
d) uma diagramação4 que proporcione leitura agradável; e
e) o objetivo indicado no início do documento.
Vamos ver, agora, mais alguns detalhes dos tipos de relatórios.

Relatório de atividades

O relatório de atividades é elaborado após uma visita técnica ou uma viagem


de estudo, por exemplo.
Normalmente, esses relatórios contêm capa, folha de rosto, sumário, resumo,
introdução, desenvolvimento e conclusão, além de apêndices.
Utiliza, mais comumente, o texto descritivo como forma de construção.

Relatório de ocorrências

O relatório de ocorrências engloba os relatórios de manutenção e os de aci-


dentes.
Esse tipo de documento tem no desenvolvimento três tópicos muito impor-
tantes: o método, o resultado e a discussão.
COMUNICAÇÃO ORAL E ESCRITA
80

No método, é registrado com detalhes o que de fato aconteceu; no resultado,


são relatadas as consequências registradas de tal fato; na discussão, são explicita-
das as possíveis causas que levaram às consequências observadas.
A conclusão do relatório deve responder ao questionamento declarado na in-
trodução do documento.

CASOS E RELATOS

O senhor Anselmo, gerente de setor de uma empresa de autopeças, re-


cebeu a indicação de dois estagiários de uma escola técnica da região.
Antes de contratá-los, ele quis saber se os estudantes teriam condições
de elaborar um relatório. Como o Anselmo é um aficionado por corridas
de carros, resolveu pedir um relatório de ocorrência.
Esse tipo de documentação técnica engloba relatórios de manutenção e
de acidentes. Ele solicitou, então, que fosse elaborado um relatório sobre
o acidente ocorrido com o piloto brasileiro Airton Senna, em 1994, a par-
tir de reportagens de revistas da época.
Os estagiários apresentaram o relatório. Depois de analisá-lo, o gerente
aprovou o trabalho, o qual você pode ler a seguir. Após a leitura, verifique
se você tem a mesma opinião do senhor Anselmo?
7 DOCUMENTAÇÃO TÉCNICA
81

RELATÓRIO DE ACIDENTE
Acidente no Autódromo de Ímola
Diego Arruda Borges
Wander Antunes Martins
22/4/2012

SUMÁRIO
INTRODUÇÃO 2
DESENVOLVIMENTO 2
Método 2
Resultado 2
Discussão 3
CONCLUSÃO 3
BIBLIOGRAFIA 3

INTRODUÇÃO
O objetivo deste trabalho é relatar um acidente ocorrido no Autódro-
mo de Ímola – Itália com um piloto de Fórmula 1. A finalidade é detectar
possíveis falhas nas normas de prevenção de acidentes.

DESENVOLVIMENTO
Método
O acidente ocorreu em 1/5/1994 às 9h12m (horário de Brasília), com o pi-
loto Airton Senna da Silva durante o Grande Prêmio de San Marino, no cir-
cuito de Ímola – Itália. Nos primeiros dois minutos, acionou-se a bandeira
amarela com o carro-madrinha na pista. Em consequência disso, o piloto
acima referido passou pela curva Tamburello em ritmo lento, dançando
na pista a fim de aquecer os pneus. O carro-madrinha saiu do circuito e os
carros retomaram a velocidade. Airton Senna passa a entrada dos boxes
a 300 Km/h. Ao chegar novamente na curva Tamburello, o volante come-
çou a oscilar e a Williams se desgarrou de seu traçado. Desgovernado,
o carro passou reto na curva e avançou sobre a faixa de cimento entre
a pista e o muro. Em seguida, a Williams espatifou-se contra o muro de
concreto numa angulação de 70 graus.
COMUNICAÇÃO ORAL E ESCRITA
82

Resultado
Apurou-se que o piloto sofreu múltiplas fraturas na base do crânio e teve
hemorragia, a qual entupiu suas vias respiratórias. Verificou-se também que
a pancada provocou o afundamento do lado direito da testa do piloto, pro-
vocando edemas e hemorragias no cérebro. A equipe médica chegou ao
local um minuto após o acidente. Logo após, o piloto foi encaminhado ao
hospital. Após quatro horas de atendimento médico, o piloto veio a falecer.
Discussão
Analisando o resultado, pôde-se chegar a três possíveis causas para o
acidente: a ruptura na barra de direção a poucos metros da curva; a sus-
pensão traseira teria quebrado na entrada da curva Tamburello; ou falha
do piloto, que poderia ter tirado o pé do acelerador ao passar pela ondu-
lação da curva Tamburello, fazendo com que o carro perdesse a aderência
e fosse puxado para fora da pista.

CONCLUSÃO
A partir do exposto, chegou-se à conclusão de que o acidente aconte-
ceu devido a uma falha mecânica: ruptura na barra de direção do carro.
Por estar muito próximo à curva Tamburello, o piloto não teve tempo há-
bil para usar os freios. Além disso, o carro não obedecia mais aos seus
comandos com a barra de direção quebrada.

BIBLIOGRAFIA
“Tinha um buraco na cabeça”. Revista Veja, Ano 27, no 19, maio/1994, p.
32-37.
São Paulo, 22 de abril de 2012. (SENAI-SP, 2007, p. 54)

Relatório de estudo ou de pesquisa

O texto do relatório de estudo ou de pesquisa deve ter linguagem precisa e um


cuidado especial com os termos técnicos. Além de apresentar necessariamente
introdução, desenvolvimento e conclusão, esse relatório deve seguir uma estru-
tura metodológica.
7 DOCUMENTAÇÃO TÉCNICA
83

Na introdução, apresenta-se um resumo do desenvolvimento, bem como o


motivo da elaboração do trabalho. O desenvolvimento descreve o que foi pes-
quisado e o método que foi empregado. A conclusão indica os motivos de, even-
tualmente, a pesquisa ainda não estar concluída e aponta para os caminhos que
ainda precisam ser percorridos até chegar-se ao termo desejado. É importante
não se esquecer de incluir referências bibliográficas em seu relatório científico.
Esse tipo de relatório, que engloba o relatório técnico, o de experiência e o
de estágio, segue as normas da ABNT. Portanto, deve conter capa, folha de rosto,
sumário, resumo, introdução, desenvolvimento, conclusão, bibliografia e conside-
rações finais.

RECAPITULANDO

Neste capítulo, você aprendeu que um relatório é a descrição feita a par-


tir de um fato, um acontecimento ou um fenômeno. Conheceu também
alguns tipos de relatório.
Viu que as partes que compõem um relatório são capa, página de rosto,
sumário, resumo, introdução, desenvolvimento, conclusão, agradecimen-
tos, bibliografia, anexos e apêndices, dependendo da extensão e com-
plexidade do trabalho.
Além disso, verificou que um bom relatório deve:
• ser impessoal nas informações;
• ser objetivo;
• usar vocabulário técnico e linguagem padrão;
• fornecer informações exatas;
• ilustrar os dados, quando necessário, com gráficos, mapas, fotos, de-
senhos ou tabelas; e
• levar o leitor a uma conclusão.
Após esse estudo, esperamos que você já tenha subsídios para começar a
elaborar seus próprios relatórios.

Você também pode gostar