Parte des del Reporte Técnico

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 la herramienta que se aprende servirá en el ejercicio profesional.

Siempre hay que tener en mente a un lector especifico, real o imaginario, cuando se escribe un reporte y siempre hay que asumir que dicho lector es inteligente pero que no está informado de la situación en particular que se está reportando.

Aunque parezca trabajo extra, un boceto ayudara siempre a ahorrar trabajo al ahorrar a organizar los pensamientos.  El resultado será un informe que no solo se presente en forma efectiva el material, sino que también tomará menos tiempo para escribirse.

• Antes de empezar a escribir, hay que decidirse por el propósito exacto del informe, y asegurarse de que cada palabra, cada oración y cada párrafo contribuyan a la finalidad del reporte y de que se haga en el momento preciso. El informe debería reflejar un sólido entendimiento del material presentado, y debería ser objetivo. nunca expresar las opiniones, ni hacer sugerencias, ni plantear quejas; poner estas cuestiones subjetivas en una carta anexa que aparezca al principio del informe.
• 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. Hay que mantener las oraciones cortas aun cuando esté tratando con material complejo. La forma puntual (frases breves y concisas) es extremadamente efectiva, pero debe usarse con mucho cuidado.
• Al principiar y finalizar cada sección del informe, hay que revisar lo escrito de acuerdo con el siguiente principio “Primero hay que indicar al lector que es lo que se le va a decir, luego hay que decirlo, y por último hay que decirle que fue lo que se le informo “. Un reporte no es una novela de misterio; no hay que tener al lector en suspenso dejando los resultados esenciales para el final. Utilizar frases como “Posteriormente se mostrará que...” y “esté error será el factor clave en la pérdida de la secuencia de los datos “, ya que estás son muy útiles para conectar varias partes del informe.

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 voltímetro fue calibrado “, en vez de “Nosotros calibramos el voltímetro “. Las reglas para trabajar son:

1. Si el evento se relaciona específicamente a un estudio ya terminado, se usa el pasado. Por ejemplo “la lectura del medidor fluctuó “.
2. Si se coloca algo que debe ser tan cierto hoy como cuando se hizo el experimento, entonces se utiliza el presente. Por ejemplo: “las corrientes de agua se riegan rápidamente conforme se mezclan con sus alrededores “

No usar 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 posición de los respiraderos afecta la eficiencia”.

Si se tienen problemas con una oración, esto debe probablemente a que se quieren unir dos ideas que no están relacionadas entre sí. Hay que detenerse a pensar un momento en lo que se está tratando de decir. Se encontrarán 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.

Se encontrará que el reporte técnico es más fácil de escribir si se sigue los siguientes pasos lógicos de preparación:

1. Cálculos
2. Figuras y Tablas
3. Introducción y Procedimiento
4. Discusión y Conclusiones Sumario

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

El formato de un reporte de investigación corresponde al criterio de cuartillas. Una cuartilla es una página tamaño carta editada dejando un interlineado de espacio y medio (1.5). La cuartilla contiene alrededor de 27 renglones con 64 caracteres cada renglón. El tipo de letra que se utiliza con mayor frecuencia es la “ARIAL “.

Los Márgenes. Para el margen izquierdo se dejan 3.0 cm. Mientras que el margen lateral derecho le corresponden 2.5 cm. Para el margen inferior corresponden 2.5 cm. Al margen superior le corresponde también 2.5 cm. Todo el texto, tablas y figuras que se incluyen en el documento deben respetar estos márgenes.

La Paginación. El numero página va centrada generalmente en el margen inferior de la cuartilla o inferior derecho. Las páginas preliminares se numeran con números romanos en letras minúscula. La portada o carátula del documento se considera como numero de página “i “, sin embargo, no se registra únicamente cuenta como “i“. A partir de ahí se numeran físicamente las páginas preliminares como “ii , iii , iv , etc . “. Las páginas que contienen el cuerpo del documento o texto, la sección de referencias, bibliografía y apéndices se paginan con números arábigos. Este número se registra en la parte inferior de la página ya sea central o derecho.

Consideraciones sobre el estilo de letra. Las palabras en otro idioma, señalamientos especiales, términos técnicos especiales deben ir editados en otro tipo de letra del cual se esté ocupando.

• Los párrafos deben tener una extensión mínima de tres renglones. Si tienen una extensión menor se cae en una situación incorrecta.  

El párrafo es una unidad básica del descrito desarrollado de manera lógica y coherente. Si está mal redactado no presenta una estructura del pensamiento lógica y organizada dificultando su comprensión. Requiere de una idea o tópico central. Si la idea es breve entonces el párrafo también lo es, en cambio sí se requiere extender la idea entonces el párrafo es más grande. En cualesquiera de los dos casos anteriores el autor requiere de razonar cuidadosamente sus argumentos. Para lograr una adecuada redacción de un párrafo se sugiere omitir términos innecesarios, expresar las ideas de manera concreta y sencilla, utilizar adecuadamente los símbolos de puntuación como, el punto, la coma, el punto y coma, entre otros y no exagerar. Lo anterior se refleja en el siguiente ejemplo:

INCORRECTO:

La productividad de los talleres del sector de servicios de impresión de la localidad se determina por la productividad de cada uno de los talleres. Con el análisis de la productividad de las demás empresas para conocer las diferencias existentes. Pero la medición de la productividad es muy relativa.

Correcto

Generalmente un informe de Ingeniería consta de tres secciones:

• Resumen de los objetivos, resultados y conclusiones
• Descripción del método analítico, experimental o de diseño y descripción de los resultados y sus aplicaciones.
• Apéndices que contienen toda la información de apoyo, junto con teoría detallada y cálculos realizados.

Un formato detallado típico se proporciona a continuación. Debe quedar claro que no todos los informes incluirán esta información.

1. Portada y Titulo
2. Resumen
3. Índice
4. introducción
5. Objetivos
6. Procedimiento

1. Teoría y Datos Calculados
2. Discusión de Resultados
3. Conclusiones
4. Recomendaciones técnicas
5. Glosario Técnico
6. Bibliografía
7. Anexos (Si fuesen necesarios)

Portada y Titulo

• RESUMEN

 Este consiste en una breve descripción escrita que indica que se ha hecho, porque 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 en forma de dialogo. Lo 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 de ultimo, y se presenta al inicio. Es muy probable que los supervisores fotocopien solo esta parte para describir un trabajo, por lo que se debe poner mucho empeño al realizarlo.

Índice

• INTRODUCCION

Esta sección indica al lector cual es el problema, así como porque y como se ha planeado la investigación. Se debería de proporcionar un listado de los objetivos tanto general como 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.

Verbos Infinitivos Para el Uso de Objetivos

• PROCEDIMIENTO Y EQUIPO

Es una lista de pequeñas citas que indican el procedimiento seguido al momento de tomar los datos. Se proporciona también la razón por la cual se hizo cada medición; por ejemplo, “ la presión de oposición fue medida en 12 puntos a lo largo del ducto , a fin de determinar la velocidad promedio “.Únicamente se menciona el equipo que fue vital para el estudio.

• TEORIA Y DATOS CALCULADOS

Aquí se muestran 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 debe mostrar también todas las derivaciones cortas de las ecuaciones más importantes y se deben usar diagramas si es necesario. Es conveniente explicar porque estas ecuaciones y teoría fueron utilizadas para resaltar la importancia de los objetivos. Se 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 apéndices.

Los resultados del autor constituyen el producto ya refinado del esfuerzo experimental. Deben presentarse utilizando tablas y figuras, de forma que puedan verse y entenderse rápidamente. Debe ser factible explicar los resultados en una o dos oraciones cortas. Si hay muchos resultados, deben hacerse referencia a las tablas y gráficas. Una lista numérica y codificada es de mucha utilidad en esta sección Asegurarse de que cada figura y tabla se tenga:

1. Un título claro y descriptivo
2. Una explicación de la simbología, si es necesario
3. Ejes perfectamente identificados y con sus respectivas unidades (en las figuras) columnas y filas debidamente identificadas y con sus respectivas unidades (tablas).
4. Notas que proporcionen la fuente de las tablas o figuras, o bien, que ayuden a la interpretación de estas

Colocar cada figura en el informe de forma que la base de esta esté en la parte baja de la hoja (tanto horizontal como vertical). No poner rótulos en los márgenes.

Las figuras deberían estar arregladas y numeradas de forma que el autor pueda referirse a ellas en la discusión. Así mismo, las tablas deben aparecer en donde se les hace mención, y no en un apéndice aparte.

• DISCUSION DE RESULTADOS

Esta sección incluye lo más importante del informe. Aquí es donde se interpretan los resultados, se califican, y se 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:

1. ¿Como se ajustan los resultados a la expectativa? Por ejemplo, ¿Las mediciones concuerdan con las predicciones teóricas o con las mediciones de otros experimentos? ¿Cuál es la explicación del autor para estas diferencias?
2. Si una variable fue medida en varias formas, ¿cómo se comparan las medidas y que significa esta comparación?
3. Cualquier figura que haya sido solicitada debe ser discutida. ¿Como debería interpretarse la gráfica? ¿Cuál es el significado físico de la figura, pendiente, puntos de inflexión, máximos, mínimos o intercepto?
4. ¿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. Debe tenerse cuidado de no decir “preciso “cuando se quiere decir “repetible “.

• 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 relacionados con los objetivos.

• RECOMENDACIONES

trabajos posteriores deberían realizarse? ¿Debería 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 hidráulica estática en una esclusa “. En otros trabajos, son los objetivos los que obligan a que se hagan recomendaciones; por ejemplo:” El objetivo era analizar la distribución de presiones en un ala a fin de determinar el peso mínimo que debería tener la misma “.

• BIBLIOGRAFÍA

Es un listado alfabético 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 año de publicación del material.

La bibliografía debe escribirse de la siguiente forma:

1. ARTICULOS

Smith A. M: (1971) “Stress Concentration Near Holes “Trans. ASME 79, pp 601-607.

2. LIBROS

Jones, B. C. (1958) “stress Analysis “. McGraw Hill, 2da. Edición pp 41-47. 

3. FOLLETOS

CATERPILLAR, Inc. (1998).” D6R “Track Type Tractor “Peoria, Illinois.

4. REPORTES TECNICOS

Adams, R. (1970) “sludge Deposits in Diesel Engines “Standard Oil Research laboratory, Harrison, N: J: Tech. Report. NTS 172, pp 23-24

• GLOSARIO TÉCNICO

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. El autor no debe enlistar únicamente unos cuantos símbolos que se consideren importantes.

• ANEXOS

Anexos son todos los contenidos que se agregan al final de un trabajo de investigación para ampliar la información presentada, pero sin resultar imprescindibles para la comprensión del fenómeno estudiado.

Si bien los anexos constituyen un complemento para la investigación, su inclusión se considera un valor agregado, ya que aportan datos relevantes que no están mencionados en el cuerpo del trabajo.

Los anexos deben ser comprendidos de manera independiente de la investigación, de tal forma que si son extraídos se pueda entender claramente de qué se tratan, como un documento separado.