Está en la página 1de 12

SUGERENCIAS PARA LA REDACCION

DE INFORMES TECNICOS

Informe Técnico: MC-001/16 Revisión: /

Proyecto: /

Fecha: 31/03/16

Autor:

Revisó:
Página: 1

SUGERENCIAS PARA LA REDACCION


DE INFORMES TECNICOS

Por:

Ing. Jorge Luis Naguil

RESUMEN

El propósito de este trabajo es presentar una serie de sugerencias para la redacción de los
informes técnicos.

Se muestra una serie de consejos referidos a la redacción y se define el formato a ser utilizado
en los informes técnicos.

Finalmente en el ANEXO se presenta un ejemplo de carátula y página de revisión.

Río Gallegos, Marzo de 2016

Fecha: dd/mm/aa Revisión: /


Página: 2

INDICE

Pág.

1. INTRODUCCION 3

2. DESARROLLO 3
2.1 Principios de redacción 3
2.2 Partes del informe 4
2.2.1 Carátula 5
2.2.1.1 Título 5
2.2.1.2 Número de Informe Técnico 5
2.2.1.3 Revisión 5
2.2.1.4 Proyecto o Materia 6
2.2.1.5 Fecha 6
2.2.1.6 Niveles de responsabilidad 6
2.2.2 Resumen 6
2.2.3 Índice 6
2.2.4 Símbolos y abreviaturas 6
2.2.5 Introducción 7
2.2.6 Desarrollo 7
2.2.7 Resultados 7
2.2.8 Conclusiones 8
2.2.9 Recomendaciones 8
2.2.10 Figuras 8
2.2.11 Referencias 8
2.2.12 Anexos 9
2.3 Formato y estilo 9
2.4 Numeración de las páginas del texto 9
2.5 Sistemas de unidades 10
2.6 Informes con más de un volumen 10
2.7 Trabajos Finales 10

3. CONCLUSIONES 10

4. REFERENCIAS 10

ANEXO: EJEMPLO DE INFORME


1. INTRODUCCION

El constante aumento del número de informes técnicos generados en el Departamento de


Ingeniería ha creado la necesidad de estandarizar la redacción de los mismos. Junto a ello existe
desde hace un tiempo la necesidad de disponer de un documento que sirva como guía para que los

Fecha: dd/mm/aa Revisión: /


Página: 3

alumnos puedan redactar correctamente sus propios informes destinados a diferentes materias. Por
las dos razones mencionadas, se ha decidido confeccionar el presente documento.

Se presentan estos consejos a modo de sugerencias dado que se pretende dejar un cierto
margen a la creatividad de los autores para adaptar la redacción de los informes técnicos a las
necesidades propias de cada proyecto.

Un informe de ingeniería es un reflejo de la capacidad y conocimiento del autor sobre la materia.

Un informe bien escrito no puede cubrir un esfuerzo medianamente realizado; sin


embargo, un informe mal elaborado puede dañar seriamente un excelente trabajo de
ingeniería.

Todos los ingenieros deben ser expertos en el arte de redactar informes. Afortunadamente, esta
es una herramienta que puede aprenderse. Las secciones que siguen proporcionan los
lineamientos necesarios para desarrollar esta técnica. El resultado de un gran esfuerzo personal
para desarrollar buenas técnicas para elaborar informes bien vale la pena, pues las herramientas
que se aprendan servirán en el ejercicio profesional.

2. DESARROLLO

2.1 Principios de redacción

a.Cuando se escribe un informe técnico siempre hay que tener en mente que el lector es
inteligente, posee igual conocimiento que uno pero que no está informado de la situación en
particular que se está reportando. Otra forma de verlo es suponer que el informe lo está escribiendo
para leerlo uno mismo dentro de varios años. Al leer el informe el lector debería poder reproducir
toda la información presente en el mismo.

b.Antes de empezar a escribir, se debe tener claro el propósito exacto del informe, y asegurarse de
que cada palabra, cada oración y cada párrafo contribuyan al propósito del informe, y de que lo
hagan en el momento preciso. El informe debería reflejar un sólido entendimiento del material
presentado, y debería ser objetivo. Nunca se deben expresar opiniones personales, ni plantear
quejas. Estas cuestiones subjetivas deberían expresarse en una carta anexa que acompañe al
informe.

c.Usar lenguaje simple, preciso y familiar. El uso incorrecto del vocabulario y de los términos
técnicos únicamente hace que el lector sienta que el autor no tiene un buen conocimiento del
material. Mantener las oraciones cortas aun cuando se esté tratando con material complejo. La
forma puntual (frases breves y concisas) es extremadamente efectiva, pero debe usarse con mucho
cuidado.

d.Al iniciar y finalizar cada sección del informe, revisar lo que ha escrito de acuerdo al siguiente
principio: "Primero dígale al lector qué es lo que le va a decir, luego dígaselo, y por último dígale
qué fue lo que le dijo". Un informe no es una novela de misterio; por lo tanto no mantener al lector
en suspenso dejando los resultados esenciales para el final. Utilizar frases como "posteriormente se
mostrará que..." y "este problema fue el principal motivo por el cual no se pudo concluir el ensayo",
ya que éstas son muy útiles para conectar varias partes del informe.

Fecha: dd/mm/aa Revisión: /


Página: 4

e.Usar la tercera persona en voz pasiva. Los pronombres personales "yo", "a mí", "tú", "Ud.", "a
nosotros", no deberían aparecer. La voz pasiva es utilizada debido a que los informes generalmente
hablan de cosas que se han hecho en el pasado; por ejemplo: "el dinamómetro fue calibrado", en
vez de "nosotros calibramos el dinamómetro".

La decisión de usar presente o pasado frecuentemente es cuestión personal. A pesar de ello, las
reglas para trabajar son:

(a) Si el evento se relaciona específicamente a un estudio ya terminado, se usa el pasado. Por


ejemplo: "la lectura del medidor fluctuó".

(b) Si se coloca algo que debe ser tan cierto hoy como cuando se hizo el estudio, entonces se
utiliza el presente. Por ejemplo: "dicha aeronave posee un movimiento oscilatorio poco
amortiguado".

f.Nunca obligue al lector a buscar información a lo largo de todo el reporte. Si es necesario repita
una información documentada en otro lugar del informe.

g.Si se tienen problemas con una oración, esto se debe probablemente a que se quieren unir dos
ideas que no están relacionadas entre sí. Deténgase a pensar un momento en lo que está tratando
de decir. Encontrará que dos o más oraciones más cortas representarán la información con mayor
claridad y harán que este pasaje sea más fácil de leer.

h.Observar que un reporte técnico es más fácil de escribir si sigue el siguiente orden lógico de
preparación:

(a) Cálculos
(b) Figuras y tablas
(c) Introducción y desarrollo
(d) Resultados y conclusiones
(e) Resumen
(f) Índice

Notar que este orden NO es el orden en que el material aparece en el informe final escrito.

i.Por ultimo, aunque parezca trabajo extra, un boceto ayudara siempre a ahorrar trabajo al ayudar a
organizar los pensamientos. El resultado será un informe que no solo presentara en forma efectiva
el material, sino que también tomara menos tiempo para escribirse.

2.2 Partes del informe

Las típicas partes que se divide un informe son las que a continuación se presentan:

⮚ CARATULA
⮚ RESUMEN
⮚ INDICE
⮚ NOMENCLATURA
⮚ SISTEMA DE REFERENCIA Y CONVENCIÓN DE SIMBOLOS

Fecha: dd/mm/aa Revisión: /


Página: 5

⮚ 1. INTRODUCCION
⮚ 2. DESARROLLO
⮚ 3. RESULTADOS
⮚ 4. CONCLUSIONES
⮚ 5. RECOMENDACIONES
⮚ 6. FIGURAS
⮚ 7. REFERENCIAS
⮚ ANEXOS:
● Desarrollo teórico detallado
● Análisis de errores
● Listado de equipos y su calibración y operación.
● Tabla completa de los datos originales y calculados.
● Manual de usuario y listados del programa de cómputos desarrollado

Queda claro que no todos los informes incluirán esta información y en otros casos es posible que
haga falta la incorporación de otros tópicos quedando los mismos a criterio del autor.

A continuación se describe cada uno de los tópicos típicos presentados anteriormente.

2.2.1 Carátula

Se adopta para los informes una carátula similar a la que acompaña a este informe. Debería
contener la siguiente información:

2.2.1.1 Título

Se lo indica con mayúsculas y es el título del trabajo presentado. El mismo debería ser breve,
claro y descriptivo.

2.2.1.2 Número de Informe Técnico

Para los informes técnicos del se adopta el siguiente formato:

MC-nnn/aa

Donde

MC: Materiales y Componentes


nnn : Número correlativo de informe
aa : Ultimo dos dígitos del año de redacción del informe.

2.2.1.3 Revisión

La primera emisión de un Informe Técnico se la identifica con Revisión: /. A las sucesivas


revisiones se las identifica con letras mayúsculas según el orden alfabético: A; B; C; D; ...............Z;
AA; AB; AC; ........................ No se emplearán, por prestarse a confusión, las letras I, O y Q.

Fecha: dd/mm/aa Revisión: /


Página: 6

Todas las páginas modificadas en una revisión de un informe serán identificadas por una nueva
letra de revisión, que se indicará en el pié de página.
La parte del texto afectada por la modificación será señalada con una barra vertical de espesor
1,5 puntos sobre el margen lateral derecho de la página. Cuando se efectúe una nueva revisión de
una página ya revisada anteriormente, se borrarán las barras verticales de la revisión anterior. Al
efectuar la revisión total de un informe, no será necesario indicar barras verticales.

Cuando se realiza una revisión se debe agregar una página de Revisión luego de la carátula
según se muestra en el ANEXO. Esta página es omitida en el documento original.

2.2.1.4 Proyecto o Materia

Se indica en letras mayúsculas el nombre del proyecto o la materia a la que pertenece la


información contenida en el informe.

2.2.1.5 Fecha

Indica la fecha de la primera edición, o bien de la revisión, del documento. El formato es libre.

2.2.1.6 Niveles de responsabilidad

Autor: se identifica el nombre, apellido y cargo del autor/autores del documento.

Revisó: se identifica el nombre y apellido del profesor/profesores encargado de la revisión del


documento.

2.2.2 Resumen

Este consiste en una breve descripción, no mayor de una hoja, indicando qué se ha hecho, por
qué se ha hecho, y cuáles son los resultados más significativos que se han obtenido. Debe usarse
lenguaje técnico y preciso, y no coloquial. La ideal del resumen es proporcionar al lector la
información suficiente para que pueda decidir si vale o no la pena leer el informe. Esta sección se
redacta al final, y se presenta al inicio. Es muy probable que los supervisores fotocopien sólo esta
parte para describir un trabajo, por lo que debe ponerse mucho empeño al realizarlo.

2.2.3 Indice

Lista los títulos principales y la página en que aparece cada uno de ellos. Enlista los subtítulos
debajo de su título principal correspondiente. La importancia de esta sección radica en que
proporciona un esquema del informe; el lector sabrá inmediatamente donde buscar lo que le
interesa.

2.2.4 Símbolos y abreviaturas

El propósito de esta sección es preparar al lector para entender cualquier desarrollo matemático
que se haya incluido. Se deben colocar todos los símbolos en orden alfabético, con todos los
símbolos griegos en una sección aparte. Para ello se puede consultar en IRAM 31, MIL-HDBK-5,
MIL-HDBK-17 y MIL-STD-12. El autor no debería enlistar únicamente unos cuantos símbolos que
considere importantes.

Fecha: dd/mm/aa Revisión: /


Página: 7

Además en este lugar se indica la convención de signos y sistema de referencia utilizado en el


informe. Por lo general éstos son indicados gráficamente, dibujando por ejemplo, un avión con los
ejes y sentidos de rotación de referencia.

2.2.5 Introducción

Esta sección le indica al lector cuál es el problema, los antecedentes que existen, así como por
qué y cómo se ha planeado la investigación. Debería proporcionar un listado de los objetivos
específicos del trabajo. Se puede usar esta sección para presentar un esquema más detallado al
lector acerca de las secciones subsiguientes, describiéndolas con una oración. Esta sección
deliberadamente excluye a los resultados.

2.2.6 Desarrollo

En esta sección se describe en detalle el trabajo realizado incluyendo todas las ecuaciones
utilizadas para obtener los resultados. Se deben numerar las ecuaciones principales, de forma que
se pueda hacer referencia a ellas fácilmente. Se deben anotar aquí todas las suposiciones y
referencias utilizadas para ampliar la comprensión sobre el tema. Se deben mostrar también todas
las derivaciones cortas de las ecuaciones más importantes y se deben usar diagramas si es
necesario. Es conveniente explicar por qué estas ecuaciones y teoría fueron utilizadas para resaltar
la importancia de los objetivos. Debe incluir también una breve explicación de los algoritmos
utilizados en los programas de computadora. Por su parte, las derivaciones complejas deben
aparecer en los anexos.

La sección de ser necesario debería subdividirse de manera tal que cada sub-sección no supere
una hoja facilitándose de esta manera la lectura.

2.2.7 Resultados

Esta sección incluye lo más importante del informe. Aquí es donde se interpretan los resultados,
se califican, y se les pone dentro del contexto del trabajo. Guía al lector de forma que siga el
proceso mental que se siguió para llegar a las conclusiones. Algunos puntos específicos que se
deben resaltar son:

(a) ¿Cómo se ajustan los resultados a las expectativas? Por ejemplo, ¿los cálculos concuerdan
con las predicciones de otras teorías o con las mediciones experimentales? ¿Cuál es la explicación
del autor para estas diferencias?

(b) Muchas veces es conveniente presentar los resultados gráficamente, si es así, cada figura
debe ser analizada. ¿Cómo debería interpretarse la gráfica? ¿Cuál es el significado físico de su
figura, pendiente, puntos de inflexión, máximos, mínimos o intercepciones?

(c) En el caso de haberse realizado mediciones, si una variable fue medida en varias formas,
¿cómo se comparan las medidas y qué significa esta comparación?

(d) ¿Cuáles son las fuentes de error para el análisis o para la recolección de datos? ¿Los
resultados están dentro del rango aceptable de error ya establecido? ¿Se ha obtenido una varianza
próxima al cero? No debe decirse que los resultados están dentro del rango experimental de error,
a menos que se haya efectuado un análisis de error.

Fecha: dd/mm/aa Revisión: /


Página: 8

2.2.8 Conclusiones

La sección de conclusiones debería iniciarse con una o dos oraciones que recuerden los
objetivos. Dado que se pueden sacar varias conclusiones de un estudio, una lista numerada es útil
frecuentemente. Cada conclusión debería constar de una oración, más una o dos oraciones
explicativas. Las conclusiones deben estar relacionadas con los objetivos. No deberían ocupar más
de una carilla.

2.2.9 Recomendaciones

Las recomendaciones son sugerencias que hace el autor, por ejemplo, respecto de los trabajos
posteriores que deberían realizarse o si debería repetirse el trabajo presentado haciéndolo de forma
diferente. Algunas veces los objetivos son tan concisos que no se requiere de recomendaciones. En
otros trabajos, son los objetivos los que obligan a que se hagan recomendaciones.

2.2.10 Figuras

Las figuras deberían estar arregladas y numeradas de forma que el autor pueda referirse a ellas
en la discusión.

2.2.11 Referencias

Es un listado alfabético de los libros, revistas, folletos, páginas WEB, etc., consultados para
hacer el informe. Las referencias se denotan en el texto colocando un supraíndice en el lugar donde
se la nombra; por ejemplo: "En un informe anterior 1 se propuso utilizar este mismo sistema”. Todas
las referencias deberían citarse en orden numérico en el texto. No deben usarse abreviaturas
excepto las conocidas por todos: AIAA, NASA, NACA, IUA; los meses pueden abreviarse. Se deben
listar todos los autores

Las referencias deben escribirse de la siguiente forma:

Artículos de un libro:
[1] Turner, M. J., Martin, H. C., and Leible, R. C., “Further Development and Applications of
Stiffness Methods,” Matrix Methods of Structural Analysis, 1st ed., Vol. 1, Macmillan, New York,
1964

Artículos de revistas:
[2] Bhutta, B. A., and Lewis, C. H., “Large-Angle-of-Attack Viscous Hypersonic Flows over Complex
Lifting Configurations,” Journal of Spacecraft and Rockets, Vol. 27, No. 2, 1990

Informes de una Empresa:


[3] Bhutta, B. A., and Lewis, C. H., “PNS Predictions of External/Internal Hypersonic Flows for
NASP Propulsion Applications,” VRA, Inc., VRA-TR-90-01, Blacksburg, VA, June 1990.

Fecha: dd/mm/aa Revisión: /


Página: 9

NASA Report:
[4] Miner, E. W., and Lewis, C. H., “Hypersonic Ionizing Air Viscous Shock-Layer Flows over
Nonanalytic Blunt Bodies,” NASA CR-2550, May 1975.
Medios Electrónicos:
[5] von Hippel, T., “Contribution of White Dwarfs to Cluster Masses,” Astronomical Journal [online],
Vol. 114, No. 4, 1998, pp. 1536–1542, URL:
http://www.journals.uchicago.edu/AJ/journal/contents/v115n4.html [citado 13 Abril 1998].
[6] Vickers, A.,”10–110 mm/hr Hypodermic Gravity Design A,” Rainfall Simulation Database [online
database], URL: http://www.geog.le.ac.uk/bgrg/lab.html [citado 15 Marzo 1998].

Informe Anónimo:
[7] “Equations, Tables, and Charts for Compressible Flow,” NACA Rept. 1135, 1953.

2.2.12 Anexos

Son parte integrante del texto que se agregarán al final del informe y podrán contener: copias de
otros documentos, tablas, figuras, manual de usuario y listado de programas, etc. a los efectos de
aclarar conceptos y dar mayor claridad sobre algún tema del informe. Cada Anexo será identificado
por su designación formada por la palabra ANEXO seguida de una letra mayúscula (excepto I, O y
Q) en orden alfabético para cada anexo, excepto de que exista uno sólo al cual no se le asignará
una letra. Las páginas se numerarán de manera correlativa anteponiendo al número de página la
letra que identifica al anexo, por ejemplo A-3, B-5, etc. El mismo criterio se aplicará para la
numeración de tablas, figuras y gráficos.

2.3 Formato y estilo

Los informes deberán escribirse en letra Arial 11 con espaciado simple, excepto el Resumen que
llevará espaciado 1 ½ . El tamaño de papel debe ser IRAM A4. El uso del formato IRAM A3 para
presentar dibujos o tablas es aceptable. En lo posible en los informes técnicos se debe tratar de
omitir el uso de colores a menos que sea absolutamente necesario.

Las figuras, dibujos y gráficos deberán, en principio, ser trazados en color negro, con espesores
de línea y escalas elegidas para lograr una adecuada legibilidad y buenas reproducciones. El
tamaño de papel “orientación horizontal” también puede emplearse cuando sea necesario.

En el caso de que una ecuación deba cortarse en dos líneas es deseable que la segunda línea
empiece con un signo matemático, por ejemplo:

A = x + Y (1 - Z)
+ tan(c + d)

2.4 Numeración de las páginas del texto

Las páginas se deberán numerar en forma secuencial. Para informes que sean muy extensos o
con capítulos preparados por distintos autores, se recomienda numerar a las páginas

Fecha: dd/mm/aa Revisión: /


Página: 10

secuencialmente dentro de cada capítulo, por ejemplo el número de página 4.1 indica la primera
página del capítulo 4. Por consiguiente dos capítulos no deberán comenzar en la misma página.

A los efectos de facilitar las revisiones del texto, podrán agregarse nuevas páginas entre las
existentes. Cada nueva página será identificada colocándole el número de la página anterior más
una letra minúscula en forma secuencial, por ejemplo entre las páginas 2 y 3 pueden agregarse las
páginas 2a, 2b, 2c, etc.
2.5 Sistemas de unidades

Se recomienda cuando sea posible, emplear el SISTEMA INTERNACIONAL DE UNIDADES


definido en la norma IRAM 2.

2.6 Informes con más de un volumen

Cuando los informes tengan más de un volumen estos llevaran la carátula, el índice y el texto. La
lista de páginas efectivas y la página de revisiones solo estarán en el Volumen N° 1. El índice de
cada volumen contendrá todos los capítulos, secciones y anexos desarrollados en ese volumen y
solamente los capítulos de los temas desarrollados en los demás volúmenes.

2.7 Trabajos Finales

Los Trabajos Finales de grado se deberán redactar con el mismo formato que los informes
técnicos con la posibilidad de agregar una página entre la carátula y el resumen dedicada a los
agradecimientos.

3. CONCLUSIONES

Se ha confeccionado una guía de informes técnicos conteniendo diversas sugerencias para la


correcta redacción de los mismos. Esta guía está destinada a servir como referencia para la
confección de los informes técnicos del Departamento Ingeniería y los informes que deban realizar
los de alumnos en diferentes materias y trabajos finales de grado.

Se considera que los lineamientos aquí presentados son suficientes para redactar la mayoría de
los informes técnicos, sin embargo, para casos especiales no cubiertos por este informe, el autor
del mismo deberá adaptar el formato a las necesidades del caso.

4. REFERENCIAS

[1] Katzoff S., “CLARITY IN TECHNICAL REPORTING”, NASA SP-7010, Second Edition, 1964.

[2] “PRINCIPIOS DE UN BUEN INFORME TECNICO,” Universidad Rafael Landívar, Facultad de


Ingeniería, URL: http://www.geocities.com/CollegePark/Library/6086/formato.html, 01/set/1999.
[Citado Febrero 2004].

Fecha: dd/mm/aa Revisión: /


Página: 11

[3] “AIAA - Submission Instruction Documents”, .Writetrack, URL: http://www.writetrack.net/aiaa/,


[Citado Febrero 2004].

Fecha: dd/mm/aa Revisión: /

También podría gustarte