miércoles, 6 de enero de 2021

RECOMENDACIONES PARA REDACCIÓN DE INFORMES TÉCNICOS

 

Introduccción

El Informe Técnico es uno de los tipos de documentos que más frecuentemente se requiere producir en el trabajo de ingeniería.

Es un trabajo que se solicita muy frecuentemente a los ingenieros jóvenes que ingresan a una organización. Es un trabajo que normalmente cierra un proceso de obtención de información o de análisis y cálculo de algún diseño.

Si usted está en la situación de tener que preparar informes con relativa frecuencia y no tiene mucha experiencia en ello o le cuesta empezarlos o tiene dudas de cómo presentarlos o recibe muchos comentarios o críticas con las primeras versiones, quizás este artículo le pueda ayudar.

Redacción

Un punto fundamental en la preparación de textos – y cada documento necesita un texto – es que tengan una redacción adecuada. El texto debe ser entendido de una sola lectura y sin mayor esfuerzo. Las ideas deben ser expresadas en oraciones lo más sencillas posibles, sin tener necesidad de repeticiones o plantear otras dudas o preguntas.

Normalmente las escuelas técnicas y de ingeniería no tienen un pensum que cuente con cursos de redacción, salvo excepciones claro está. Esto hace que los profesionales jóvenes que se inician en la preparación de informes, deben perder algún tiempo buscando informes referenciales para guiarse y usando frases hechas, oraciones comunes que a veces no son las más apropiadas.

Como recomendación en general, para los estudiantes de carreras técnicas o profesionales recién graduados es recomendable que tomen algún cursillo de redacción de informes, este puede formar parte del grupo de materias electivas de su institución o puede conseguirlo en instituciones externas.

A continuación planteamos algunas recomendaciones generales a la hora de escribir un texto técnico:

1)    Después del primer borrador, póngase en el lugar del lector que lee el informe por primera vez y que no está al tanto de lo que se pretende demostrar o investigar. Además si el informe va destinado a personal no técnico, debe revisarse para usar un lenguaje que pueda ser entendido por ellos.

2)    Evitar la necesidad de aclaratorias como: “es decir que”; o “en otras palabras”. Si después de una oración, frase, o párrafo usted necesita completar con “es decir que” o “en otras palabras” usted debe revisar la oración o párrafo para que sea comprensible sin necesidad de aclaratorias adicionales.

3)    Use oraciones sencillas. Evite oraciones muy largas o complejas u oraciones enlazadas para las cuales el lector necesite releer para asegurarse cuál es el sujeto, el verbo y el predicado.

4)    No de preferencia al uso de anglicismos si existen palabras en castellano que describan el sustantivo. Si en el lenguaje técnico la palabra más conocida corresponde al sustantivo en otro idioma, siempre se puede usar un glosario para explicar el término que no es tan conocido. Si es imprescindible el uso de un sustantivo en otro idioma lo mejor es resaltarlo poniéndolo entre comillas o usando fuente itálica. Al final en un glosario, se puede explicar el término.

5)    Cuando dude entre usar comas o puntos para separar oraciones y frases, prefiera el uso de punto y seguido. Lo importante en un informe es que se entiendan las ideas y para ello lo mejor es separar las oraciones con punto y seguido. Si a continuación trata de explicar una idea diferente, use punto y aparte.

6)    Cuando se enumeran opciones, categorías o clases de cosas de las cuales se va a comentar o explicar, estas se separan con punto y coma. Al terminar la lista se usa punto y aparte.

7)    Tenga un diccionario a mano. Siempre es bueno buscar sinónimos para no repetir palabras, con mayor razón si se tiene problemas de ortografía. Ahora con el uso de programas con corrección automática, asegúrese que el corrector automático no esté desactivado. Aun cuando tenga un corrector automático puede ser que el mismo no tenga un diccionario completo de vocablos, por lo cual, la revisión del texto siempre debemos hacerla para asegurarnos que el texto está correcto.

Estructura

Antes de empezar la redacción es necesario definir con cuál estructura se va a trabajar. Esta se define en un índice. Si la organización para la cual se produce el informe tiene una estructura típica para la preparación de informes asegúrese de tenerla antes de empezar. Es muy inconveniente tener que adaptar un texto a una estructura diferente una vez terminado, aunque esté en borrador.

Puntos imprescindibles de la Estructura de un informe:

a)    Objetivo. Todo informe debe tener un objetivo. El mismo debe quedar bien explicado pero no es conveniente que sea un texto muy amplio. Lo ideal es que se explique en uno o dos párrafos.

b)    Conclusiones. Todo informe debe tener una o varias conclusiones si es el caso. Las mismas deben quedar explicadas completas y sin dar lugar a dudas. En la mayoría de los informes técnicos el punto “Conclusión” o “Conclusiones” se coloca al final del informe, salvo en el caso siguiente.

c)    Resumen Ejecutivo. Si el informe va dirigido a una Junta Directiva o a uno o varios ejecutivos que necesitan tomar una decisión económica como consecuencia de las conclusiones obtenidas, la o las conclusiones deben ir al inicio del informe, normalmente con el título de “resumen ejecutivo” esto con la indicación al ejecutivo de que es el punto que le define la conclusión que necesita sin tener que leer todo el informe.

Puntos complementarios normalmente incluidos en la Estructura de un informe:

a)    Metodología.  En este segmento se explican los métodos usados por el autor o autores para los procesos de cálculo, procesos de medición, de obtención de muestras, de análisis de componentes, de observación, etc. Estos métodos no deben ser inventados sino deben ser establecidos por normas o textos técnicos reconocidos.

b)    Normas. Se deben indicar claramente cuáles normas se están usando para el trabajo del informe, si aplica.

c)    Cálculos. Los cálculos deben estar muy bien explicados, ayudándose con referenciar tablas y gráficos en la sección de anexos para no complicar el texto. Es importante recordar colocar en glosario la información de las variables y las unidades utilizadas.

d)    Descripción. Si amerita, se redacta la descripción del trabajo hecho, con el fin de dar una explicación completa del informe.

e)    Anexos. En esta sección se incluyen otros documentos a los cuales se haya hecho referencia, incluyendo imágenes como fotografías, dibujos, esquemas, copia de normas, copias de tablas, etc., a todos los cuales se haya hecho referencia en el texto principal. Es importante que exista un índice de anexos y que cada elemento anexo esté identificado en dicho índice.

Formato

Normalmente las organizaciones tienen plantillas o formatos para los documentos como informes, si no se dispone de un standard o formato, asegúrese de usar un formato lo más simple y sencillo posible.

No hay comentarios:

Publicar un comentario

NOTES ABOUT THE PROJECT MANAGEMENT INDICATORS “CPI” AND “SPI”

This article aims to summarize some comments on the most common project management measurement indicators: CPI and SPI. The Cost Performance...