Principios para un buen informe técnico

FACULTAD DE INGENIERIA 1er. Semestre de 1,999. PRINCIPIOS DE UN BUEN INFORME TECNICO Un informe de ingenieria es un reflejo directo de la habilidad 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 danar seriamente una excelentie pieza de ingenieria. Todos los ingenieros deben ser expertos en el arte de redactar informes. Afortunadamente, esta es una herramienta que pueda aprenderse. Las secciones que siguen proporcionan los lineamientos necesarios para desarrollar esta tecnica.

El resultado de un gran esfuerzo personal para desarrollar buenas tecnicas para elaborar informes bien vale la pena, pues la herramientas que se aprendan serviran en el ejercicio profesional. PRINCIPIOS DE REDACCION 1. Siempre tenga en mente a un lector especifico, real o imaginario, cuando escriba un reporte; y siempre asuma que dicho lector es inteligente pero que no esta informado de la situacion en particular que se esta reportando. 2. AUNQUE PAREZCA TRABAJO EXTRA, UN BOCETO AYUDARA SIEMPRE A AHORRAR TRABAJO AL AYUDARLO A UD. A ORGANIZAR SUS PENSAMIENTOS.

EL RESULTADO SERA UN INFORME QUE NO SOLO PRESENTARA EN FORMA EFECTIVA EL MATERIAL, SINO QUE TAMBIEN TOMARA MENOS TIEMPO PARA ESCRIBIRSE. 3. Antes de

Lo sentimos, pero las muestras de ensayos completos están disponibles solo para usuarios registrados

Elija un plan de membresía
empezar a escribir, decidase por el proposito exacto de su informe, y asegurese de que cada palabra, cada oracion y cada parrafo contribuyan al proposito del informe, y de que lo hagan en el momento preciso. El informe deberia reflejar un solido entendimiento del material presentado, y deberia ser objetivo. Nunca exprese sus opiniones personales, ni haga sugerencias ni plantee quejas; ponga estas cuestiones subjetivas en una carta anexa que aparezca al principio del informe. . Use lenguaje simple, preciso y familiar. El uso incorrecto del vocabulario y de los terminos tecnicos unicamente hace que el lector sienta que el autor no tiene un buen conocimiento del material. Mantenga sus oraciones cortas aun cuando este tratando con material complejo. La forma puntual (frases breves y concisas) es extremadamente efectiva, pero debe usarse con mucho cuidado. 5. Al principiar y al finalizar cada seccion de su informe, revise lo que ha escrito de acuerdo al siguiente principio: «Primero digale al lector que es lo que le va a decir, luego digaselo, y por ultimo digale que fue lo que le dijo».

Un reporte no es una novela de misterio; no mantenga al lector en suspenso dejando los resultados esenciales para el final. Utilice frases como «posteriormente se mostrara que… » y «este error sera el factor clave en la perdida de la secuencia de los datos», ya que estas son muy utiles para conectar varias partes del informe. 6. Use la tercera persona en voz pasiva. Los pronombres personales «yo», «a mi», «tu», «Ud. «, «a nosotros», no deberian 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 voltimetro ue calibrado», en vez de «nosotros calibramos el voltimetro». La decision de usar presente o pasado frecuentemente es cuestion personal. A pesar de ello, las reglas para trabajar son: (a) Si el evento se relaciona especificamente a un estudio ya terminado, se usa el pasado. Por ejemplo: «la lectura del medidor fluctuo». (b) Si se coloca algo que debe ser tan cierto hoy como cuando se hizo el experimento, entonces se utiliza el presente. Por ejemplo: «los corrientes de agua se riegan rapidamente conforme se mezclan con sus alrededores». 7. Nunca obligue al lector a buscar informacion a lo largo de todo el reporte.

Use frases como «el incremento del 40% en CO con los respiraderos cerrados indica que no hubo aire suficiente para obtener combustion completa. Esto explica la mayoria de los descensos en la eficiencia de combustion, que fueron de 82% a 68%». No use frases como «el valor del 12% de CO con los respiraderos cerrados puede compararse con los datos obtenidos con los respiraderos abiertos para demostrar como la posicion de los respiraderos afecta la eficiencia». 8. Si se tienen problemas con una oracion, esto se debe probablemente a que se quieren unir dos ideas que no estan relacionadas entre si.

Detengase a pensar un momento en lo que esta tratando de decir. Encontrara que dos o mas oraciones mas cortas representaran la informacion con mayor claridad y haran que este pasaje sea mas facil de leer. 9. Encontrara que su reporte tecnico es mas facil de escribir si sigue el siguiente orden logico de preparacion: (a) Calculos (b) Figuras y tablas (c) Introduccion y procedimiento (d) Discusion y conclusiones (e) Sumario Note que este orden NO es el orden en que el material aparece en el informe final escrito. FORMATO DEL INFORME Generalmente, un informe de ingenieria consta de tres secciones: a) Resumen de los objetivos, resultados y conclusiones. (b) Descripcion del metodo analitico, experimental o de diseno y drescripcion de los resultados y sus aplicaciones. (c) Apendices que contienen toda la informacion de apoyo, junto con teoria detallada y calculos realizados. Un formato detallado tipico se proporciona a continuacion. Debe quedar claro que no todos los informes incluiran esta informacion. 1. Titulo 2. Resumen 3. Indice 4. Nomenclatura 5. Introduccion y objetivos 6. Procedimiento 7. Teoria y datos calculados 8. Discusion de resultados 9. Conclusiones 10.

Recomendaciones tecnicas 11. Figuras 12. Referencias 13. Apendices – Desarrollo teorico detallado – Analisis de incertezas (error) – Listado de equipo, y su calibracion y operacion – Tablas completas de los datos originales y calculados – Programas de computadora utilizados ESPECIFICACIONES GENERALES DEL REPORTE 1. Titulo: El reporte deberia tener un titulo claro y descriptivo. Debe presentar la seccion, los companeros de grupo y la fecha del informe. 2. Resumen: Este consiste en una breve descripcion escrita que indica que se ha hecho, por que se ha hecho, y cuales son los esultados mas significativos que se han obtenido. Debe usarse lenguaje tecnico y preciso, y no coloquial. La ideal del resumen es proporcionar al lector la informacion suficiente para que pueda decidir si vale o no la pena leer el informe. Esta seccion se redacta de ultimo, y se presenta al inicio. Es muy probable que los supervisores fotocopien solo esta parte para describir un trabajo, por lo que debe ponerse mucho empeno al realizarlo. 3. Indice: Lista los titulos principales y la pagina en que aparece cada uno de ellos. Enlista los subtitulos debajo de su titulo principal correspondiente.

La importante de esta seccion radica en que proporciona un esquema del reporte; el lector sabra inmediatamente donde buscar lo que le interesa. 4. Nomenclatura: El proposito de esta seccion es preparar al lector para entender cualquier desarrollo matematico que se haya incluido. Se deben colocar todos los simbolos en orden alfabetico, con todos los simbolos griegos en una seccion aparte. El autor no debe enlistar unicamente unos cuantos simbolos que considere importantes. 5. Introduccion: Esta seccion le indica al lector cual es el problema, asi como por que y como se ha planeado la investigacion.

Deberia proporcionar un listado de los objetivos especificos del trabajo. Se puede usar esta seccion para presentar un esquema mas detallado al lector acerca de las secciones subsiguientes, describiendolas con una oracion. Esta seccion deliberadamente excluye a los resultados. 6. Procedimiento y equipo: Es una lista de pequenas citas que indican el procedimiento seguido al momento de tomar los datos. Se proporciona tambien la razon por la cual se hizo cada medicion; por ejemplo, «la presion de oposicion fue medida en 12 puntos a lo largo del ducto, a fin de determinar la velocidad promedio».

Unicamente se menciona el equipo que fue vital para el estudio. 7. Teoria y datos calculados: Aqui se muestran las ecuaciones utilizadas para obtener los resultados. Se deben numerar las ecuaciones principales, de forma que se pueda hacer referencia a ellas facilmente. Se deben anotar aqui todas las suposiciones y referencias utilizadas para ampliar la comprension sobre el tema. Se deben mostrar tambien todas las derivaciones cortas de las ecuaciones mas importantes y se deben usar diagramas si es necesario. Es conveniente explicar por que estas ecuaciones y teoria fueron utilizadas para resaltar la importancia de los objetivos.

Debe incluir tambien una breve explicacion de los algoritmos utilizados en los programas de computadora. Por su parte, las derivaciones complejas deben aparecer en los apendices. Los resultados del autor constituyen el producto ya refinado de su esfuerzo experimental. Deben presentarse utilizando tablas y figuras, de forma que puedan verse y entenderse rapidamente. Debe ser factible explicar los resultados en una o dos oraciones cortas. Si hay muchos resultados, debe hacerse referencia a las tablas y graficas. Una lista numerica y codificada es de mucha utilidad en esta seccion.

Asegurese de que cada figura y tabla tenga: (a) Un titulo claro y descriptivo. (b) Una explicacion de la simbologia, si es necesario. (c) Ejes perfectamente identificados y con sus respectivas unidades (en las figuras). Columnas y filas debidamente identificadas y con sus respectivas unidades (tablas). (d) Notas que proporcionen la fuente de las tablas o figuras, o bien, que ayuden a la interpretacion de las mismas. Coloque cada figura en el informe de forma que la base de la misma este en la parte baja de la hoja (tanto horizontal como verticalmente). No ponga rotulos en los margenes. 8.

Discusion de resultados: Esta seccion incluye lo mas importante del informe. Aqui es donde se interpretan los resultados, se califican, y se les pone dentro del contexto del trabajo. Guia al lector de forma que siga el proceso mental que se siguio para llegar a las conclusiones. Algunos puntos especificos que se deben resaltar son: (a) ? Como se ajustan los resultados a las expectativas? Por ejemplo, ? las mediciones concuerdan con las predicciones teoricas o con las mediciones de otros experimentos? ?Cual es la explicacion del autor para estas diferencias? (b) Si una variable fue medida en varias formas, ? omo se comparan las medidas y que significa esta comparacion? (c) Cualquier figura que haya sido solicitada debe ser discutida. ?Como deberia interpretarse la grafica? ?Cual es el significado fisico de su figura, pendiente, puntos de inflexion, maximos, minimos o interceptos? (d) ? Cuales son las fuentes de error para el analisis o para la recoleccion de datos? ?Los resultados estan dentro del rango aceptable de error ya establecido? ?Se ha obtenido una varianza proxima al cero? No debe decirse que los resultados estan dentro del rango experimental de error, a menos que se haya efectuado un analisis de error.

Debe tenerse cuidado de no decir «preciso» cuando se quiere decir «repetible». 9. Conclusiones: La seccion de conclusiones deberia iniciarse con una o dos oraciones que recuerden los objetivos. Dado que se pueden sacar varias conclusiones de un estudio, una lista numerada es util frecuentemente. Cada conclusion deberia constar de una oracion, mas una o dos oraciones explicativas. Las conclusiones deben estar relacionadas con los objetivos. 10. Recomendaciones: ?Que trabajos posteriores deberian realizarse? ?Deberia repetirse este trabajo en una forma diferente?

Algunas veces los objetivos son tan concisos que no se requiere de recomendaciones; por ejemplo, cuando el objetivo es «determinar la fuerza hidraulica estatica en una esclusa». En otros trabajos, son los objetivos los que obligan a que se hagan recomendaciones; por ejemplo: «El objetivo era analizar la distribucion de presiones en un ala a fin de determinar el peso minimo que deberia ener la misma». 11. Figuras y tablas: Las figuras deberian estar arregladas y numeradas de forma que el autor pueda referirse a ellas en la discusion. Asimismo, las tablas deben aparecer en donde se les hace mencion, y no en un apendice aparte. 2. Referencias: Es un listado alfabetico de los libros, revistas o folletos consultados para hacer el informe. Las referencias se denotan en el texto colocando el nombre del autor, y el ano de publicacion del material; por ejemplo: «Una linea que muestra el resultado de Smith (1,971) es comparada con los datos de la eficiencia de la Figura 7». Las referencias deben escribirse de la siguiente forma: (a) Articulos: Smith, A. M. (1,971), «Stress Concentration near Holes» Trans. ASME 79, pp. 601-607. (b) Libros: Jones, B. C. (1,958), «Stress Analysis». McGraw Hill, 2da. dicion, pp 41-47. (c) Folletos de fabricantes (generalmente no tienen autor): CATERPILLAR, Inc. (1,998), «D6R» Track Type Tractor», Peoria, Illinois. (d) Reportes tecnicos: Adams, R. (1,970), «Sludge Deposits in Diesel Engines», Standard Oil Research Laboratory, Harrison, N. J. Tech. Report. NTS 172, pp 23-24. 13. Apendices: Utilice los apendices para almacenar los detalles importantes de su trabajo, pero que no son necesarios para que el lector entienda el reporte, a la vez que podrian provocar una interrupcion en el pensamiento del lector si se incluyen en el trabajo.

Los apendices pueden utilizarse para hacer referencia de ellos en las secciones de Teoria y de Discusion. Si no se hace referencia alguna a ellos en el trabajo, es porque estan de mas. Finalmente, no debe almacenarse en ellos material que no ha sido explicado en el cuerpo del informe. Es posible que el lector pase por alto los apendices, sin perder por ello la comprension de las partes vitales del informe.