Sie sind auf Seite 1von 13

Ing. GABRIEL E. ROCHA C. Of.

453-314
e-mail: gerochac@unal.edu.co 1

COSAS A TENER EN CUENTA AL ESCRIBIR INFORMES TCNICOS

OBJETIVO DE LOS INFORMES

Uno de las cosas que se persigue en el curso de Laboratorio de Operaciones


Unitarias es que el estudiante adquiera experiencia en la preparacin de informes
tcnicos.

Un requisito esencial en cualquier ingeniero es que posea habilidad para hacer


reportes escritos. En casi todos los casos, los ejecutivos de las empresas citan
entre las principales debilidades de los ingenieros recin egresados la
incapacidad para reportar los resultados de su trabajo. Con frecuencia, el
problema es que falta claridad, y se debe a una pobre redaccin, mal ortografa o
a defectos de sintaxis o de estilo; pero en muchas oportunidades es ocasionado
por descuido o falta de experiencia.

Cuando se trata de comunicar informacin, como en los reportes tcnicos, lo


principal es ser claro y explcito. Debe escribirse para el lector, y tener presente
siempre que aquel ha de poder entender fcilmente lo que se quiere expresar; l
no puede resolver las ambigedades y no puede pretenderse que acuda al autor
del informe en busca de aclaracin.

En este curso, los reportes estarn dirigidos al profesor y a sus compaeros de


curso. Es necesario, entonces, tener en cuenta que se escribe para personas que,
en trminos generales, conocen acerca del tema -- con cuatro o ms aos en la
Carrera-- pero que no han realizado el proyecto objeto del informe. Tambin, es
importante recordar que en el curso se est simulando que se est en una
situacin industrial, de modo que debe mantener en mente que sus informes son
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 2

presentaciones formales que usted hace ante sus superiores --en lo tcnico o en
lo administrativo-- y ante sus pares --sus colegas--; no se trata de "informes de
Laboratorio de Unitarias"..

Existen diversos estilos de reportes tcnicos. En este curso se emplear una


forma que es muy utilizada en empresas en las cuales los objetivos se apoyan en
tecnologa --es decir, compaas en las que se toman decisiones importantes para
su misin (por lo general, el lucro) pero donde lo que importa no es la tecnologa
en s sino que las decisiones empresariales sean correctas--. En otros trminos,
se usarn reportes tcnicos orientados a los negocios.

ORGANIZACIN DEL INFORME

Algo fundamental antes de comenzar a escribir un informe es establecer cmo


estarn organizadas las ideas que se desea expresar. Eso significa, claro, que
hay que empezar por elaborar una lista de dichas ideas. En principio, basta con
escribir unas cuantas palabras clave o ideas cortas sueltas, sin enlace entre ellas;
informales, si se quiere. Despus, hay que organizarlas; se sugiere que se
organicen jerrquicamente: primero van las conclusiones, enseguida las cosas
ms importantes, luego otras algo menos importantes, y as sucesivamente; en
cada grupo de stos, despus, se repite el proceso de organizacin jerrquica. Al
final se habr elaborado un esqueleto del informe. No se trata de algo definitivo,
pues a medida que ste se escriba puede encontrarse conveniente modificarlo,
pero seguramente los cambios a realizar sern menores.

Durante la escritura del informe, las ideas plasmadas en el esqueleto sern


desarrolladas. Esto tambin es recomendable hacerlo de manera anloga a la
descrita en el prrafo anterior: empezar expresando las conclusiones y las
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 3

cuestiones ms destacadas, luego explicarlas y presentar el sustento que se


requiera.

CONSIDERACIONES DE FORMA Y ESTILO

Los informes deben tener aspecto profesional. Es deseable que se escriban


usando procesador de palabra y ayudas de cmputo para elaborar tablas, grficas
y figuras; y que las ecuaciones se hagan con un editor de ecuaciones. No
obstante, cuando existan dificultades para lograr un excelente producto mediante
el uso de tales ayudas, es aceptable que se escriba a mano, siempre y cuando se
utilice letra uniforme y clara y las grficas y dems ilustraciones, al igual que las
tablas, sean elaboradas con instrumentos apropiados. En cualquier caso, todo
debe resultar con apariencia profesional: completo, limpio, sin tachones ni
enmiendas, debidamente organizado , agradable a la vista, amigable.

El informe debe ser presentado en papel tamao carta. Todas las grficas y tablas
deben ser realizadas en papel apropiado, del mismo tamao (o doblado segn las
normas vigentes para tal fin). Cuando se haga en procesador de palabra, ha de
usarse letra tipo Arial de 12 puntos, con espaciado de 1.5 lneas; los mrgenes
deben ser de una pulgada en los cuatro lados. Puede escribirse por ambas caras
de las hojas, siempre y cuando stas no sean tan delgadas que parte de lo escrito
al respaldo alcance a verse desde el frente. Es deseable que el documento pueda
extenderse abierto sobre un escritorio; por ello, no se recomienda usar grapas, a
menos que se trate de pocas pginas y resulte sencillo doblarlas cerca del
margen izquierdo para leerlas --en otros casos es mejor escribir solamente por
una cara--.

El contenido ha de redactarse en forma directa, simple y concisa, y debe


corresponder a la informacin requerida para tomar decisiones. La mayora de los
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 4

prrafos han de estar conformados por frases orientadas a acciones, escritas en


primera persona. El texto, as como las tablas, grficas y figuras, han de ser
sencillos y directos; agradables de leer.

Adems del cuerpo principal del informe, ste deber ir acompaado por toda la
documentacin y material de soporte para todas las conclusiones y
recomendaciones planteadas --es fundamental tener presente que el informe ha
de guiar al lector, seccin tras seccin, a travs del anlisis tcnico en el que se
apoyan dichas conclusiones y recomendaciones--.

ASPECTOS GENERALES

Es importante que el informe demuestre un buen manejo del idioma. Por ejemplo,
una ortografa deficiente, el mal uso de los signos de puntuacin, la falta de
concordancia entre sujeto y verbo, el manejo de distintos tiempos verbales en la
misma frase, son cosas que molestan y distraen durante la revisin de los
documentos. Se recomienda elaborar los textos a varias manos, y someterlos a
revisiones completas y concienzudas por terceros. En cuanto a la ortografa, es
de gran ayuda correr a la primera versin del texto el diccionario de un procesador
de palabra; sin embargo, debe tenerse en cuenta que estos diccionarios no
distinguen ciertos errores (los que tienen que ver con palabras que tienen ms de
una forma de escritura aceptada --por ejemplo: mas/ms, liquido/lquido,
vaso/bazo, -- o con palabras que estn escritas correctamente pero que no son
las que se quera escribir --por ejemplo: pero/puro, eficiencia/deficiencia, --).

Es preferible usar la voz activa, excepto cuando la frase resulte ms agradable o


apropiada en pasiva.

Para describir hechos y conclusiones relacionadas con los ensayos, use siempre
el tiempo pasado (La presin de operacin fue... Antes de alimentar la columna se
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 5

ceb la bomba por medio de...). En cambio, en la discusin y anlisis de


resultados puede combinar pasado y presente. Tambin ha de usarse presente
para expresar verdades generales (El ter es ms voltil que el agua... La presin
de vapor del benceno a 25C es....) y para anunciar la presentacin de datos y
resultados (los datos aparecen en la tabla 6).

Es conveniente que cada frase exprese solamente una idea o unas cuantas ideas
pero estrechamente relacionadas entre s.

Se recomienda revisar el texto escrito, frase por frase, y eliminar las frases y
palabras innecesarias; eso hace ms fluida la lectura.

Toda frase debe iniciar con una palabra; no con un smbolo ni con un nmero.

Ha de evitarse las lneas viudas; eso significa que una hoja no debe terminar con
la primera lnea de un prrafo, excepto que sea la nica lnea del mismo.
Tampoco es aceptable terminarla con un ttulo.

NMEROS

Los enteros inferiores a 11 se escriben en el texto con palabras, excepto cuando


son medidas de cantidad, cuando se refieren a algn ordinal (como en "la Tabla
8..., la seccin 3, etc.), o cuando son bastantes, o cuando estn escritos junto con
algunos ms grandes.

En los nmeros con decimales ha de usarse el punto y no la coma como


separador. Adems, si son menores que la unidad, deben llevar el cero antes del
punto.
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 6

Puede escribirse un guin para separar la parte entera del resto cuando se
escriben fracciones (ejemplo: 1-1/4).

Cuando se entregan datos y resultados, o cuando se hacen clculos, solamente


deben reportarse cifras significativas.

ECUACIONES

Si va a hacerse referencia a ellas, es necesario numerarlas. En tal caso todas


deben llevar nmero; la numeracin debe ser consecutiva, a medida que
aparecen en el informe. Los nmeros se escriben justificados al margen derecho,
entre parntesis; no es necesario antecederlos con cosas como "Ec.", "Ec. No",
"Ecuacin",....

En general, las ecuaciones cortas pueden ir dentro del texto del prrafo, pero las
otras deben ir separadas del texto al menos por una lnea, centradas en la pgina.
Cuando hacen parte del texto, con ellas ha de seguirse las reglas de puntuacin
corrientes; en el otro caso se recomienda no usar puntuacin despus de la
ecuacin.

Cuando se coloquen antes de una ecuacin palabras como "por lo tanto",


"entonces", "donde", "reemplazando", y otras similares, stas deben ir alineadas a
la izquierda con el prrafo correspondiente.

En las ecuaciones ha de utilizarse la notacin convencional que se maneja en el


contexto del problema que se est tratando. Solamente en casos especiales se
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 7

justifica cambiar dicha notacin, pero debe advertirse al lector en forma oportuna
y clara los cambios.

Es conveniente agregar una explicacin de los smbolos que aparecen en la


ecuacin, debajo de ella. Dicha explicacin puede darse como una lista --cada
smbolo en un rengln diferente--, pero tambin es apropiado hacerlo en un
prrafo, siempre y cuando no se pierda claridad y no resulte muy extenso (p. ej.:
... donde L es la velocidad de masa de solvente, D el dimetro de la columna, y 1
y 2 corresponden a la entrada y la salida, respectivamente...). Una alternativa que
tambin se acepta consiste en colocar toda la nomenclatura en una seccin
aparte, ordenada alfabticamente; en tal caso las ecuaciones se presentan sin
explicacin de los smbolos --pero ha de tenerse cuidado para garantizar que se
emplee una nomenclatura uniforme y consistente, y que no se omita ningn
smbolo--.

ABREVIATURAS

Es fundamental evitar usar abreviaturas en el texto. Para las variables debe


utilizarse nombres apropiados; en especial, no es admisible a cambio de los
nombres el uso de smbolos o abreviaturas (...para despejar el h es necesario
hallar primero el Nu y el Re a una T....).

Las unidades de medida se abrevian solamente cuando van despus de una


cantidad numrica (25 BTU/h, 34 ohm, 9 bar, 17 psi).

Las abreviaturas de las unidades de medida van en singular y sin punto (5 cm, y
no 5 cm., ni 5 cms). Adems, no son arbitrarias; debe usarse las aprobadas por la
comunidad cientfica correspondiente (por ejemplo, la ISO o el ICONTEC).
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 8

Las abreviaturas en general se escriben en minsculas (Son excepciones: BTU,


Vol. --cuando se refiere a una publicacin--, Ec. --a una ecuacin-- y No. --a un
ordinal--).

Solamente en grficas, tablas o clculos, se admite usar smbolos como ', ", , @,
%, #, $ y / ( a cambio de ft, in, psi, en, por ciento, nmero, pesos y por,
respectivamente). En el texto no se admite.

REFERENCIAS

Los informes tcnicos contienen mucha informacin que no es producto directo


del trabajo reportado, sino que se origina en diversas fuentes --libros, catlogos,
sitios de internet, revistas, patentes, entrevistas-- y sirve de apoyo al autor en la
exposicin de la informacin. Es fundamental que se documente suficiente el
informe. En esencia, en el sitio en que se use cualquier clase de informacin --
datos, tablas, grficas, opiniones, teora, y en general toda cosa que no sea
obvia o del dominio de todos-- que se extraiga de alguna fuente distinta al trabajo
mismo debe darse la referencia correspondiente.

Es mejor presentar una lista numerada de las referencias en una seccin aparte,
llamada "Referencias", que colocarlas como pie de pgina; no es necesario que la
lista se haga en algn orden especfico. En la lista nicamente ha de aparecer
material que haya sido citado en el texto.

El objeto de las referencias es soportar o documentar lo que se est exponiendo y


brindar la posibilidad al lector de acudir a las fuentes citadas para verificar o
ampliar la informacin. Por eso las referencias deben ser especficas, claras,
concretas (evitar escribir, por ejemplo, dato tomado del Perry). En general, un
estilo apropiado tiene el formato [#, pg __ {, tabla __}{, grfica __}], en el cual #
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 9

corresponde al nmero de la fuente que se lista en la seccin de Referencias del


informe y la informacin entre llaves es opcional (ejemplo: Estos resultados se
asemejan a algunos reportados en [15, pg. 42, tabla 3-2].... La humedad relativa
del aire en Bogot, en ese perodo, fue, en promedio, del 67% [4, pg 16]).

En el anexo puede encontrarse una gua acerca de la forma que se sugiere para
escribir las referencias en los informes. Hay otras formas aceptadas; no interesa
el formato que escoja, es importante utilizarlo de manera consistente.

FIGURAS Y TABLAS

Pueden ir ubicadas en el cuerpo principal del informe, o en un anexo o apndice.


Cuando van el en cuerpo, deben estar en el lugar apropiado (p. ej., no presentar
tablas de datos y resultados en la misma seccin); en general, deben ubicarse
despus -- pero lo ms cerca posible-- del sitio donde se mencionan primero.

Cada una debe tener un ttulo que la describa (p. ej., no basta escribir Figura 9;
tampoco es suficiente Figura 9. T vs P, ni Figura 9. Temperatura vs Presin;
mucho mejor sera algo como Figura 9. Variacin de la temperatura con la
presin. Ensayo con relacin aire/alimento de 3/1.), y subttulos o explicaciones
suficientes para que no sea necesario acudir al texto para comprenderlas por
completo. El ttulo debe estar arriba de la tabla; en las grficas abajo.

No deben aparecer figuras ni tablas que no se empleen en el informe; toda tabla o


figura debe tener algn uso, distinto a llenar espacio (alguna de la informacin
que contienen ha de usarse como datos o para la discusin).
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 10

La fuente de la cual la tabla o figura sea tomada debe ser referenciada. El mejor
sitio para colocar la referencia es debajo de la tabla o figura, despus de
"Fuente:".

En las grficas "xy", debe evitarse los ttulos tipo "y vs x", y contra x" o "y en
funcin de x", que nada aportan al lector, pues los rtulos de los ejes evidencian
lo que se indica en dichos ttulos.

Los ttulos deben ir justificados a la izquierda o centrados con respecto a la tabla o


figura.

Es deseable que cada tabla o figura quede en una sola hoja, y dentro de los
mrgenes del texto. Cuando deban partirse en varias hojas, en cada una es
necesario escribir el ttulo; adems, ha de agregarse "(continuacin)" en todas las
pginas, excepto donde comienza.

Cuando se elaboren en formato horizontal --o apaisado--, han de colocarse de


modo que el texto pueda leerse con el documento en posicin de lectura normal o
girndolo 90 grados en direccin de las manecillas del reloj (es decir, la parte
superior de la tabla o figura a la izquierda de la pgina).

Es preferible usar una tabla que una grfica cuando convenga presentar la
informacin con toda su precisin. Los datos experimentales siempre han de ir en
una tabla, nunca en una grfica --a menos que est acompaada por la tabla
correspondiente--.

Los encabezamientos de las tablas han de ser suficientemente claros, y deben


incluir unidades; de ser posible, es preferible usar nombres descriptivos de las
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 11

variables y no smbolos (p. ej., "difusividad" y no "D" ni "DAB"; casi siempre, esto
es ms simple de lograr cuando los encabezados van en la primera columna que
cuando van en la primera fila).

Los valores numricos deben tener presentacin uniforme. Hay que evitar usar
demasiados decimales (o, mejor, evitar usar cifras muy poco o nada
significativas); los valores deben reflejar su precisin (p. ej., no tiene sentido
escribir 90.12345678 F y tampoco aporta mucho presentar un nmero de
Reynolds de 100015, en lugar de 90 y 100000, respectivamente).

Tambin hay que procurar escribir los nmeros en el formato que resulte ms
simple para el lector; en especial, cuando sea posible ha de evitarse la notacin
cientfica (p. ej., es mucho ms "legible" 68.2F que "6.82E01F).

En las tablas, los nmeros deben estar alineados en cada columna segn la
posicin del punto decimal (haya o no haya tal punto).

En las grficas las curvas deben ser suaves y llenar la mayor parte que se pueda
de ellas. La variable independiente debe ir en el eje x; la dependiente en el eje y.
El tamao de las grficas debe ser apropiado, pensando en que resulten fciles
de observar. Se recomienda evitar poner demasiadas curvas en una misma
grfica, excepto cuando puedan distinguirse fcilmente.

Cuando una curva sea generada mediante una ecuacin solamente ha de


mostrarse la curva y no los puntos calculados. En cambio, los puntos
experimentales o los tomados de datos de otra fuente han de mostrarse
claramente mediante un smbolo de forma y tamao adecuado (visible,
identificable; sin exagerar).
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 12

Cuando se trata de datos o resultados experimentales, no debe trazarse una lnea


de tendencia a menos que se vaya a usar para la discusin de los resultados; si
se trazan, las curvas deben mostrar una disposicin clara --la idea es demostrar
que se ajustan a cierta tendencia fsica; debe evitarse unir los puntos
simplemente--.

Cuando se tracen lneas de tendencia es fundamental escoger bien la forma de


sta. Ante todo, debe ser racional --p. ej., no tiene sentido escoger un polinomio
de grado 13 para una serie de datos de presin de vapor entre 15 y 35C, o una
funcin coseno para datos del factor de friccin en trminos de la velocidad en
rgimen laminar --. Para la seleccin, es importante considerar primero, si lo hay,
una forma correspondiente a algn modelo fsico apropiado --en los ejemplos
anteriores, ln P vs 1/T y f vs 1/v, respectivamente--. En todo caso, cuando se opte
por una funcin no lineal debe ser porque los datos tienen suficiente precisin y
porque la posicin de los puntos lo justifica.

En las grficas, cuando se conozca la incertidumbre de los valores representados


y se quiera incluir una lnea de tendencia, conviene trazar barras de error en cada
punto mostrando dicha incertidumbre. Eso facilita trazar lneas correspondientes a
funciones ms sencillas --en tales casos basta que la lnea cruce las barras, no
los puntos--.

En las grficas, en lo posible, han de usarse escalas decimales. Solamente se ha


de acudir a otras escalas --logartmica, probabilstica, etc.--, cuando sea
estrictamente necesario o conveniente. Las escalas deben cubrir un intervalo de
valores adecuado, procurando la fcil visualizacin de los mismos y a la vez que
la curva cubra la mayor parte del rea. La escala numrica ha de ser uniforme
(hay que evitar, por ejemplo, marcar solamente los valores que corresponden a
Ing. GABRIEL E. ROCHA C. Of. 453-314
e-mail: gerochac@unal.edu.co 13

los datos; y tambin evitar colocar una sola marca) y debe ir rotulada claramente
(no usar smbolos sino los nombres de las variables correspondientes; no olvidar
las unidades); los rtulos deben ir paralelos a los ejes, escritos para leer hacia la
derecha --el del eje x-- o hacia arriba --el del eje y--.

Cada curva o conjunto de datos debe ser fcilmente observable e ir debidamente


identificado. Puede usarse rtulos junto a las curvas, o bien emplear smbolos
distintos (puntos, cuadrados, tringulos,...) para cada conjunto, o diferentes
formas de trazo (continuo, punteado, con guiones,..) para cada curva e
identificarlos en una leyenda adjunta, situada en un lugar conveniente.

Los datos que no sean propios y aparezcan en una grfica deben ser
referenciados; la cita se coloca debajo del ttulo de la grfica, despus de
"Fuente:". Si se quiere hacer explcito, puede incluirse la frase "Este trabajo" para
referirse a datos propios.

Das könnte Ihnen auch gefallen