INFORMES ESCRITOS DE INGENIERÍA

INFORMES ESCRITOS DE INGENIERÍA
Adaptado de :
•
The Writing Center, University of Wisconsin-Madison
•
Notes for Writing Engineering Reports. School of Chemical
Engineering and Materials Science. University of Oklahoma.
•
Robert Delaney,Citation Styles for Research Papers. Long
Island University, C.W. Post Campus.
El propósito de un reporte de ingeniería es provocar un cambio.
El estilo del informe será por lo tanto función del cambio esperado.
En algunos casos, tales como proyectos universitarios rutinarios o consultas sobre disciplinas
simples, el propósito no cambia de un informe a otro y se usa el mismo estilo para todos los
informes. Para trabajos menos rutinarios la persona que escribe el informe deberá identificar
claramente el cambio propuesto ( la propuesta ) y seleccionar un estilo apropiado.
ESTILOS DE PRESENTACIÓN
Se debe tener presente que el contenido de un informe de ingeniería es más importante que el
estilo. Un estilo efectivo no mejora un mal trabajo de ingeniería; sin embargo, es muy común que
excelentes trabajos de ingeniería no se visualicen, y por lo tanto se ignoren, debido al uso de un
estilo incomprensible. Producto de lo anterior, la segunda mejor idea, apropiada y entusiastamente
implementada comúnmente desplazará a aquella , que siendo mejor, no fue adecuadamente
presentada y por lo tanto no fue entendida.
Se debe tener presente que si el lector no entiende un informe es el autor del informe el que ha
fallado, no el lector. Las diferentes personas o lectores procesan la información de diferente
manera. El escritor efectivo apelará a esos distintos procesos a través de la incorporación al texto
de narraciones, analogías, ejemplos, tablas, diagramas de flujos y representaciones gráficas. El
informe exitoso será aquel que “use todos estos botones” sin ser redundante.
LOS LECTORES
Cada evento, no importa cuan grande o pequeño sea, puede ser descrito en:
•
•
•
•
una frase
un párrafo
una página
ó una serie de libros
Un informe de ingeniería debe entregar a los distintos tipos de lectores la posibilidad de escoger
cual nivel leer. Específicamente, un informe debería ser confeccionado para al menos tres tipos
distintos de lectores:
Ø
El Ejecutivo – Un lector de un minuto.
Por ejemplo, el vicepresidente de la empresa, a quien le interesa saber si el proyecto preparado es
rentable y se informa acerca de la tecnología utilizada, la inversión requerida, los riesgos
involucrados, las condiciones de mercado, etc.
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
1 de 8
Ø
El Administrador – Un lector de cinco minutos.
Por ejemplo, el administrador del proyecto, quien será el llamado a implementar o evaluar el costo
de implementar el proyecto. Este deberá determinar cuanta gente necesitará, cuanto tiempo
tomará, que presupuesto es necesario y principalmente se formará un juicio acerca de los méritos
técnicos del proyecto. El dará una mirada al informe buscando información acerca de la tecnología
utilizada, asegurándose que los resultados sean coherentes. Esta persona no buscará encontrar
errores en el informe ( a menos que sean muy evidentes ) sino más bien se formará una opinión.
Será necesario entonces tener todo lo que esta persona requiere disponible y a la vista.
Ø
El Lector de Detalle – El Lector Meticuloso.
Por ejemplo, el ingeniero encargado de realizar otros estudios basados en el informe presentado, o
de implementar los hallazgos o sugerencias. Una regla de oro dirigida a estos lectores es que
deberían tener toda la información acerca de los datos usados, las suposiciones hechas, las
herramientas (algoritmos, software, etc.) utilizadas y todos los pasos seguidos, de manera tal que
pueda repetir todo el proceso sin tener que hacer ninguna pregunta al autor del informe. Esto no
significa que haya que abrumar a los lectores del informe con todos los detalles de lo que se hizo,
paso por paso. De ser así, se correría el riesgo de irritar al administrador y a los lectores ejecutivos.
Por lo tanto debe haber un cierto balance.
Aunque cada tipo de lector consigue un nivel distinto de detalles, todos deben recibir el mismo y
consistente mensaje.
COMO ESCRIBIR PARA TRES LECTORES
Afortunadamente, el escribir para los tres tipos de lectores definidos no requiere diferentes estilos
de escritura o de informe. El estilo de “pirámide invertida” permite a cada uno de los lectores
escoger y encontrar rápidamente la cantidad de detalles que ellos necesitan. El Lector Ejecutivo
leerá solamente el resumen del informe y quizás algunos títulos; y por supuesto, el Lector detallista
se sumergirá en cada palabra y en cada frase de cada párrafo. Escribir para el Administrador es lo
que requiere una elaboración más cuidadosa. Así como el informe debería comenzar estableciendo
la idea más relevante, el iniciar cada sección y subsección con una frase resumen permitirá al
lector decidir rápidamente cuanta atención dar a cada sección particular. Una buena técnica es
decir al lector con sólo una frase lo que cubrirá la sección, por ejemplo diciendo: “Esta sección
describe...”. Otra manera es finalizar la sección con un párrafo simple que resuma los aspectos
principales. Las tablas y figuras son elementos de gran utilidad para los lectores de cinco minutos;
por ello es conveniente asegurarse que “cuenten la historia o parte de la historia” sin necesidad de
leer todo el texto.
SECUENCIA
La secuencia para escribir un informe no es la misma usada para hacer el trabajo.
Una secuencia para preparar el informe podría ser del tipo:
1.
2.
3.
4.
5.
6.
Identificar los lectores.
Determinar el propósito del Informe – que puede ser diferente al propósito del trabajo. El
propósito del informe no necesariamente estará incluido en el texto del informe.
Planificar la presentación
•
¿Cómo puedo hacer que se entiendan mejor las ideas?.
•
¿Qué cartas, gráficos, figuras y/o representaciones gráficas se deberían usar?.
•
¿Cuál debería ser la apariencia del informe?
Escribir el cuerpo del informe.
Escribir el resumen.
Seguir trabajando y complementando el informe con más detalles.
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
2 de 8
En la primera vuelta de este proceso probablemente se terminará con algo más que el esqueleto
del informe.
Se debe siempre tener presente que el resumen es la parte más importante del informe. Este
demandará una presentación clara, concisa y segura. Sin embargo, debería ser fácil de armar. Si
éste requiriera mucho más que las primeras ideas de las distintas secciones del informe, se
debería considerar volver a escribir algunas secciones del informe.
FORMATO DEL INFORME
El informe de un trabajo de Ingeniería no es una narración simple describiendo el trabajo en
secuencia que éste fue realizado. De hecho, la secuencia de este informe es exactamente
contrario del estilo novelesco de “¿quién es el asesino?”. En otras palabras, se debe poner
respuesta primero. No se requiere que el lector casual tenga que leer dificultosamente
descripción del trabajo total para saber la conclusión a que se llegó.
la
al
la
la
El mejor formato a usar es aquel que está normado o el requerido por el mandante. En todo caso,
un formato posible es el siguiente:
1.
2.
3.
4.
5.
6.
7.
8.
9.
Ø
Título (Usar página separada para informes con más de cinco páginas).
Resumen ( Un cuarto a media página incluyendo las mayores recomendaciones).
Tabla de Contenidos (Para informes con más de 8 páginas).
Introducción.
Estado del Arte (Si es apropiado).
Planteamiento del problema, Explicación, Métodos de ensayos, Otras Secciones.
Resultados y Recomendaciones.
Bibliografía.
Anexos.
Titulo
El título debería:
•
•
Describir en forma clara y precisa el contenido, de manera tal que los lectores puedan
decidir leer el informe.
Entregar palabras claves para la indexación.
Los títulos no deberían:
•
•
•
Ø
Incluir palabras tales como “estudio sobre...”, “una investigación de...”
Usar abreviaciones.
Usar lenguaje no formal.
Resumen
Para preparar el resumen se debe responder a la pregunta:
•
¿ Cuál es el objetivo del informe?, (en pocas palabras y sin detalles específicos).
Para tener la respuesta se debe:
•
•
•
•
Establecer los objetivos principales. ( ¿Qué se investigó?, ¿Porqué? ).
Describir los métodos. ( ¿Qué se hizo? ).
Resumir los resultados más importantes. ( ¿Qué se encontró? ).
Establecer las mayores conclusiones y materias significativas.(¿Qué
resultados?).
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
implican
los
3 de 8
Notas Adicionales:
1.
2.
3.
4.
Longitud máxima: 50 a 300 palabras.
Proceso: Extraer puntos relevantes de cada sección. Condensarlos en sucesivas revisiones.
No incluir referencias a figuras, tablas o fuentes.
No incluir información que no aparezca en el informe.
Ø
Introducción
Para escribir la introducción se puede usar la siguiente guía:
PREGUNTAS A RESPONDER
CÓMO RESPONDERLAS
¿Cuál es el problema?
•
•
Describir el problema investigado.
Resumir la información relevante para proveer el
contexto y los conceptos que hagan entendible la
experiencia..
¿Porqué es importante?
•
Revisar investigaciones relevantes para entregar
racionalidad. (Qué conflicto, preguntas sin respuestas,
población no evaluada, u otras se espera responder).
•
Describir
brevemente
la
experiencia:
Hipótesis,
investigación, metodología experimental, metodología
de diseño, justificación de métodos alternativos si
existen, etc.
Qué solución (o camino
solución) se propone?
de
Notas Adicionales:
1.
2.
3.
4.
5.
Ø
Ir de lo general a lo específico. (problema real – investigación bibliográfica – experiencia).
Captar la atención del lector. (¿Qué se debe hacer?, ¿cuáles son los riesgos?).
Dejar claro la relación entre el problema y la solución, entre el problema y el diseño de las
experiencias, entre las investigaciones previas y la actual.
Ser selectivo, no exhaustivo, al escoger las citas bibliográficas y al determinar la cantidad de
detalles a incluir. (En general, mientras más relevante sea un artículo para el estudio, más
espacio se le debe prodigar y más tarde aparecerá en la introducción).
Consultar al guía o instructor si es o no necesario resumir los resultados y conclusiones en la
introducción.
Sección de Métodos (Cuerpo del Informe).
Para esta sección se tiene la siguiente guía útil para trabajos científicos.
PREGUNTA A CONTESTAR
CÓMO CONTESTARLA
¿Cómo se estudió el problema?
•
Explicar brevemente el tipo de procedimiento
científico usado.
¿Qué se usó? (Materiales)
•
Describir los materiales y equipos utilizados.
¿Cómo se procedió? (Procedimiento)
•
Explicar los pasos seguidos en las experiencias.
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
4 de 8
Notas Adicionales:
1.
2.
3.
4.
5.
6.
Entregar los detalles suficientes para replicar las experiencias. (Por ejemplo para un artículo en
una revista sería conveniente incluir los materiales usados como asimismo las fuentes,
fabricantes y lugares, de los reactivos y aparatos).
Ordenar los procedimientos cronológicamente o por tipos de procedimientos.
Usar tiempo verbal pasado para describir qué se hizo.
Cuantificar donde sea posible: concentraciones, mediciones, cantidades, temperaturas, etc.
No incluir detalles de procedimientos estadísticos comunes.
No mezclar resultados con procedimientos.
Ø
Resultados
Para la sección de resultados se debe responder a la pregunta:
•
¿qué se observó?.
Para obtener la respuesta, para cada procedimiento o experimento se debe:
•
•
Describir brevemente la experiencia sin los detalles de la sección de métodos ( una frase o
dos ).
Entregar los resultados principales, respaldados por datos seleccionados:
o Representativo: más común.
o Mejor caso: mejor ejemplo o la excepción.
Notas Adicionales:
1.
2.
3.
4.
5.
Ordenar los resultados en forma lógica:
• De más a menos importante
• De simple a complejo
Usar tiempo pasado para describir que pasó.
No recurrir a simplemente repetir la tabla de datos; seleccionar.
No interpretar resultados.
Evitar usar palabras de más.
Ø
Discusión
A continuación se entrega una guía para una discusión efectiva en informes científicos.
PREGUNTAS A CONTESTAR
COMO CONTESTARLAS
¿Qué implican las observaciones?
•
Resumir los hallazgos más importantes al comienzo.
¿Qué conclusiones
desprender?
•
Para cada resultado principal:
- Describir los modelos, principios y relaciones
entregados por los resultados.
- Explicar cómo los resultados se relacionan con las
expectativas y la bibliografía citada en la
introducción. ¿Existe concordancia, contradicción o
hay excepciones a la regla?
- Explicar plausiblemente cualquier concordancia,
contradicción o excepción.
- Describir qué investigación adicional podría resolver
las contradicciones o explicar las excepciones.
se
pueden
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
5 de 8
PREGUNTAS A CONTESTAR
¿Cómo se ajustan los resultados
en un contexto más amplio?
COMO CONTESTARLAS
•
•
•
•
Sugerir las implicaciones teóricas de los resultados.
Sugerir aplicaciones prácticas de los resultados.
Extender los hallazgos a otras situaciones.
Proyectar los resultados: ¿Sirven los resultados para
ayudar a comprender una materia más amplia?
Notas Adicionales:
1. Ir de lo específico a lo general: literatura, teoría, práctica.
2. No ignorar el aspecto principal: ¿Alcanza el estudio los objetivos planteados en la
introducción?
3. Hacer explicaciones completas.
• Dar evidencias para cada conclusión
• Discutir las posibles razones para hallazgos esperados e inesperados.
4. No generalizar en exceso.
5. No ignorar desviaciones en los datos.
6. Evitar especulaciones que no puedan ser medidas en el futuro cercano.
Ø
Bibliografía
En el momento de escribir la bibliografía, y si no hay nada normado, se puede recurrir a los
siguientes estilos:
•
•
•
•
•
APA : Para psicología, educación y otras ciencias sociales.
MLA: Para trabajos en las áreas de literatura, artes y humanidades.
AMA: Para medicina, salud y ciencias biológicas.
Turabian: Designada para estudiantes universitarios para ser usadas en todas las materias.
Chicago: que se usa en todas las materias en el “mundo real” por libros,
revistas,
periódicos y otras publicaciones.
En nuestro caso particular usaremos el estilo Turabian.
Evaluación de las fuentes de información.
La evaluación de las fuentes de información puede ser un proceso complicado. Existe una gran
cantidad de información disponible que no es segura, fraudulenta o errónea. Por lo tanto es
importante determinar si las fuentes encontradas son veraces y verificables.
La información encontrada en las bibliotecas generalmente son fáciles de evaluar porque ellas ya
han sido revisadas al menos un par de veces antes de que el usuario las lea: primero por el editor
que verifica que la información es segura; y después por el encargado de la biblioteca quien
determina si el item es o no apropiado. Las fuentes disponibles libremente en internet comúnmente
no pasan a través de la misma revisión; luego se requiere con ellas un trato mucho más cuidadoso.
En todo caso, el tipo de investigación en curso dirá cuan exhaustivamente se debe examinar las
fuentes. Además, probablemente un autor será menos crítico con la información recopilada por
interés personal que aquella requerida para una publicación, ya que ésta última requiere de fuentes
seguras y documentadas.
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
6 de 8
En relación a lo anterior, para determinar si una fuente escrita es apropiada se debería revisar los
siguientes criterios:
•
•
•
•
¿Tiene el autor la experiencia para escribir sobre la materia?
¿Está la información actualizada?
¿Qué dicen los revisores de la fuente?
¿Es la fuente apropiada para la investigación?
Asimismo, para determinar la pertinencia de una información online sería conveniente revisar lo
siguiente:
•
•
•
•
•
¿Cuál es la credibilidad de la fuente?
¿Cuál es el grado de seguridad?
¿Está actualizada?
¿Es objetiva?
¿Se entrega detalles que respalden los datos?
Ética en la era de la Información
El término ética se refiere a un particular código de conducta basado en normas comúnmente
aceptadas por toda la sociedad. Para que la Web continúe prosperando es importante que sea
usada de acuerdo a ciertas normas mínimas de conducta. La siguiente información se relaciona
con la ética y se entrega con el objeto de facilitar y comunicar una forma de pensar (“thinking
process”) que ayudará a promover el crecimiento continuo como también a preservar la
confiabilidad de la información en la Web.
Software piratas. Con tanta información disponible libremente es fácil perder de vista que ciertos
individuos o fabricantes no desean regalar su software. Recordar el antiguo adagio: “you get what
you pay for”. Tener en consideración que estas copias ofrecidas libremente pueden traer un
invitado no deseado – un virus.
Plagio. La idea de una investigación es estudiar lo que otros han publicado para formarse una
opinión propia. Cuando se usa información de otras personas, o cuando se resume la información
encontrada en libros, artículos o páginas Web, se debe reconocer el autor original. Si se usa las
palabras o ideas de alguien sin darles el crédito correspondiente, se está cometiendo un tipo de
robo llamado plagio. El plagio puede ser tan obvio como hacer el papel de otra persona o
proyectar como propio diferentes secciones de varios trabajos. También es incorrecto copiar textos
desde páginas Web u otras fuentes sin indicar de donde vienen.
¿Cómo se evita el plagio? Tomar notas claras y seguras acerca del lugar donde se encuentren
ideas específicas. Escribir la información completa de la cita para cada item. Usar “comillas”
cuando se escriba directamente las palabras escritas por otra persona. Siempre reconozca y de el
crédito correspondiente al autor original por su información y sus ideas.
Citas Bibliográficas. Las citas bibliográficas es el proceso mediante el cual se da el crédito a las
fuentes utilizadas para escribir un paper. Las citas bibliográficas se pueden indicar en el texto (
referencias) o al final del trabajo (Bibliografía). En algunos casos puede resultar complicado
determinar que necesita ser citado. Para esto se puede usar la siguiente regla:
Si al comienzo de la investigación se conocía la información, generalmente no necesita ser citada.
De la misma manera no es necesario citar hechos muy conocidos, tales como fechas, las que se
pueden encontrar en muchas enciclopedias. Toda otra información tales como referencias, citas
textuales, estadísticas e ideas siempre deberían ser citadas.
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
7 de 8
Los formatos de las citas deben ser consistentes de manera que otros investigadores puedan
identificar rápidamente las fuentes usadas y localizarlas. Para encontrar las guías para un formato
particular se debe seleccionar el estilo. Para el caso particular de trabajos, informes de laboratorio,
informes de Investigación, informes de tesis y otros de ingeniería se propone el estilo Turabian.
Citas bibliográficas estilo Turabian. Guía rápida.
Para citas bibliográficas usando este estilo siga el siguiente código de colores:
Autor (es)
Volumen
Año
Páginas
Título del Libro
Lugar de Publicación
Título del artículo
Editor
Título del periódico
Otra información
LIBRO
Okuda, Michael, and Denise Okuda. 1993. Star Trek Chronology:The history of the
future.New York:Pocket Books.
ARTÍCULO DE UN JOURNAL
Wilcox, Rhonda V. 1991. Shifting roles and synthetic women in Star Trek: The
Next Generation. Studies in Popular Culture 13 (junio): 53-65
ARTÍCULOS EN PERIÓDICOS O REVISTAS
Di Rado, Alicia. 1995. Trekking through college: Classes explore modern society
using the world of Star Trek. Los Angeles Times, 15 marzo, A3
ARTÍCULO DE ENCICLOPEDIA
Los libros de referencia muy conocidos no se incluyen en la bibliografía pero son citados entre
paréntesis en el texto.
Ø (Theodore Sturgeon, “Science fiction”, en Enciclopedia Americana, 1995 ed.)
ARTÍCULO O CAPÍTULO DE UN LIBRO
James, Nancy E. 1988. Two sides of paradise: the Eden Myth according to Kirk and
Spock. En Spectrum of the fantastic, ed. Donald Palumbo, 219-223. Westport,
CT: Greenwood.
SITIO WEB
Lynch, Tim. 1996 DS9 Trials and Tribble-ations review [on-line]. Peoria, IL:
Bradley University; available from
http://www.bradley.edu/campusorg/psiphi/DS9/ep/503r.html ; Internet;
accessed 8 octubre 1997.
Notas
•
•
•
•
•
Existen dos diferentes tipos de estilo Turabian. El descrito corresponde a aquel que cada vez es
más común.
Ordenar las citas en la bibliografía alfabéticamente por autor, intercalando libros, artículos, etc.
Comenzar la segunda línea y las siguientes 5 espacios más adentro.
Si no existe el autor, partir con el título seguido de la fecha.
Sitios Web: incluir la fecha de creación de la página (o última revisión) y la fecha en que fue
consultada.
INFORMES DE INGENIERÍA (Versión preliminar / José Torres T.)
8 de 8