Você está na página 1de 4

Documentação Técnica

1. O que é?

É um conjunto de registros de inspeção, relatórios e certificados referentes a todo o


conjunto ou subconjunto, na sua escrita transmite informações de teor técnico a uma ou
várias pessoas. Com o objetivo de divulgar, registrar, ensinar e ou informar.

2. Categorias

Entre algumas categorias, pode-se destacar:

2.1 Livro – Reunir um conjunto de conhecimentos sobre determinada matéria.

Exemplo: Física com Aplicação Tecnológica - Vol. 1


Dirceu D'Alkmin Telles, João Mongelli Neto.

2.2 Relatório – Relatar um trabalho efetuado.

Exemplo: Relatório de Inspeção de Segurança.


2.3 Dissertação – Apresentar e justificar uma determinada ideia, conceito ou teoria.

Exemplo: “Há 15 bilhões de anos, o Universo todo estaria agrupado em um espaço


ridiculamente pequeno e então explodiu, dando origem às galáxias, estrelas e planetas
como o nosso. Antes disso, segundo os cientistas, não havia nada. ” Mario Novello, Do
Big Bang ao Universo Eterno.

2.4 Monografia – Dissertação aprofundada sobre um ponto particular de uma


ciência, normalmente escrito por uma só pessoa.

2.5 Artigo Científico – Descrever em detalhe uma descoberta científica;

2.6 Manual de Utilização – Mostrar como se usa determinado aparelho ou sistema.

Exemplo: Modo de montagem das peças de uma câmera fotográfica.


3. Criação

Ao escrever um documento técnico deve‐se começar por definir claramente que tipo de
documento se pretende criar, a quem se destina o documento, baseando no âmbito que
ele será executado e o que se pretende incluir no mesmo.

3.1 Conteúdo

O conteúdo a incluir no documento depende naturalmente do trabalho realizado. Como


ponto de partida, toda a informação que for relevante para a compreensão do trabalho
realizado ou para que se consiga atingir os objetivos do documento, deve ser incluída.

3.2 Código

O tom utilizado quando se pretende fazer um comentário a outra publicação deve ser
profissional e não pejorativo.

Para a criação de um bom documento técnico existem diversas regras que devem ser
cumpridas. Muitas delas são fáceis de cumprir pois são bastante objetivas, com por
exemplo a legendagem de todas as figuras apresentadas no documento.

O texto deve ser escrito no tempo presente e na forma impessoal. Não se deve usar a
primeira pessoa do singular.

Num texto em português não se devem utilizar palavras em inglês a não ser que não
haja alternativa, sendo essas algumas das regras mais essenciais.

3.3 Organização

Cada tipo de documento técnico deve ser organizado tendo em conta o seu propósito e
de forma a que a informação transmitida seja facilmente entendida.

4. Conclusão

Os documentos técnicos são muito importantes em diversos locais, desde o ambiente


acadêmico, até mesmo o profissional. É de suma importância entender a relevância
desses documentos no dia a dia. Relatórios de serviços, Trabalhos de Conclusão de
Cursos, Manuais e diversos outros textos com teores técnicos, passam por um rigoroso
esquema de elaboração, desde a parte prática, até a execução da atividade pelos textos
retratadas.

5. Referências

ALEGRIA, F. A. C. Produção de Documentos Técnicos : TEXTO DE APOIO PARA OS


ALUNOS DO INSTITUTO SUPERIOR TÉCNICO., p. 1-50, fev./2011. Disponível em:
https://fenix.tecnico.ulisboa.pt/downloadFile/3779577383536/Producao%20de%20Doc
umentos%20Tecnicos%20-%203fev11.pdf. Acesso em: 9 nov. 2019.

Documentação técnica de processos de fabricação. Disponível em:


https://www.infosolda.com.br/biblioteca-digital/livros-senai/documentacao/207-
documentacao-tecnica-de-processos-de-fabricacao. Acesso em: 9 nov. 2019.

MEDIUM. Technical Writing — Tipos de Documentos Técnicos. Disponível em:


https://medium.com/@darioems/technical-writing-tipos-de-documentos-
t%C3%A9cnicos-6dd350d4a9fb. Acesso em: 9 nov. 2019.