ESCRIBIENDO INFORMES, PUBLICACIONES Y TESIS

Propuesta estructural, de contenidos, y gram atica de la Escuela Universitaria de Ingenier a Mec anica de la Universidad de Tarapac a

ricardo franco mendoza garc ia

Escuela Universitaria de Ingenier a Mec anica Universidad de Tarapac a, Arica, Chile rmendozag@uta.cl

March 12, 2013

Debido a un requerimiento institucional, se entregan consejos pr acticos para la elaboracion de informes, publicaciones cient cas y tesis de los estudiantes de la Escuela Universitaria de Ingenier a Mec anica de la Universidad de Tarapac a. Se trata de una receta extra da de libros y cursos de escritura que se enfoca en la estructura, los contenidos y la gram atica t ecnica, y que ha probado ser efectiva en las publicaciones de algunos acad emicos de la unidad. contents 1 Introduccion 2 1.1 El mensaje, lo m as importante 2 1.1.1 Contribucion 2 al conocimiento 1.2 La audiencia 3 1.2.1 Claridad 3 1.2.2 Adecuacion 3 1.2.3 Responsabilidad 3 2 Componentes de un documento 4 2.1 T tulo 4 2.2 Resumen 4 2.3 Introduccion 5 2.4 M etodos 6 2.5 Resultados 7 2.6 Discusion 7 2.7 Conclusion 7 3 Gram atica T ecnica 8 3.1 [Algunos] tipos de frases 8 3.1.1 Frases completas 8 3.1.2 Frases independientes y subordinadas 8 3.2 Uso de la coma; , 9 3.2.1 Conjugaciones coordinantes; y, e, o, u, sino, pero. 9

Conjugaciones subordinantes; mientras, debido, porque aunque, desde, cuando, donde, si, antes, despu es, hasta, etc. 3.3 Puntuacion 10 de listas 3.3.1 Listas simples 10 3.3.2 Listas de fragmentos 10 3.3.3 Listas de frases completas 11 4 Conclusion 11 References 1 11

3.2.2

introducci on

El siguiente documento pretende inicialmente servir de gu a para la estructuracion cas y tesis de grado de informes, publicaciones cient de los estudiantes de la Escuela Universitaria de Ingenier a Mec anica de la Universidad de Tarapac a1 . Nace debido a un requerimiento de las autoridades de la Escuela que busca inculcar en los estudiantes la capacidad de comunicar ideas t ecnicas de forma clara y concisa. Las sugerencias de este documento son mayormente una traduccion literal al espanol de los consejos propuestos en el libro Writing Scientic Papers and Technical Reports [1] complementados por los conceptos entregados en el curso Writing Scientic Papers in English impartido por el Maersk McKinney Moller Institute2 . Se entrega esta receta debido a la mejora que ha signicado en el porcentaje de aceptacion de las publicaciones en ingl es de algunos acad emicos de la Escuela. Aunque el documento se enfoca principalmente en la estructuracion de los documentos antes mencionados, tambi en se entregan algunos consejos referentes a el contenido, la gram atica t ecnica y el formato t pico de las publicaciones cient cas. La ortograf a esta fuera del alcance de este trabajo. 1.1 El mensaje, lo m as importante

El proceso de escritura se facilita mucho y uye de manera natural si se tiene claro el mensaje del documento en elaboracion. El mensaje puede ser, por ejemplo: una respuesta a un requerimiento hecho por un profesor en el caso de un informe; o una contribucion al conocimiento en el caso de las publicaciones cient cas y tesis.
El proceso de escritura se facilita si se tiene claro el mensaje del documento.

1.1.1

Contribuci on al conocimiento

Las opciones para contribuir al conocimiento son diversas y, muchas de ellas, de naturaleza simple. Lo importante es trabajar en algo que no se haya hecho con anterioridad y describir claramente ese trabajo. Para asegurar la originalidad de un trabajo se necesita una
1 http://www.uta.cl 2 http://www.mmmi.sdu.dk

lectura a-priori del estado del arte del tema a tratar, y para e sto es muy conveniente tener acceso a bases de datos con informacion actualizada (e.g., http://ieeexplore.ieee.org). Dicho esto, algunos ejemplos de contribuciones al conocimiento son: una descripcion a o dispositivo innovador; de una teor alisis de como una teor a conocida puede ser aplicada a un an una nueva situacion o dominio; una prueba tangible de un concepto innovador; un re-an alisis de un trabajo existente o su replicacion con variaciones menores; etodo espec co se comporta en una investigacion de como un m frente a una evaluacion andar; o est una comparacion etodos (uno de ellos puede ser una entre dos m propuesta personal). 1.2 La audiencia

El objetivo ultimo de un documento escrito es que la audiencia, o lector nal, entienda el mensaje. Si e sto no ocurre, puede que un gran descubrimiento cient co pase desapercibido. 1.2.1 Claridad

Con esto en mente, se pregunta lo siguiente: si se debe explicar un experimento de laboratorio o una contribucion ca a un cient experto en la materia y a una abuelita, a qui en se le debe dedicar m as esfuerzo? Seguramente, la respuesta fue a la abuelita. Aunque este ejemplo es extremo, al momento de redactar un documento no se debe asumir que la audiencia ser a un experto en la materia. Al contrario, es muy conveniente asumir que se trata de estudiantes de primer o segundo ano de universidad; con el consecuente esfuerzo que e sto demanda en la explicacion. 1.2.2 Adecuaci on

Para continuar, puede que audiencias tan diversas como veterinarios e ingenieros se interesen en una investigacion en comun que involucre, por ejemplo, dispositivos GPS para el control de la poblacion de animales. En estos casos, es conveniente elaborar documentos separados y adecuar la escritura para una audiencia o la otra; es decir, poniendo mayor cuidado en la descripcion ecnicos para los de los aspectos t veterinarios y en la de los aspectos biologicos para los ingenieros. 1.2.3 Responsabilidad

Es conveniente asumir que la audiencia seran estudiantes de primer o segundo en la materia. ano

Se debe tener claro que el lector nunca tiene la culpa de no entender el mensaje; es el escritor quien debe poner m as esfuerzo en la explicacion y redaccion hasta que cualquier persona dentro de la audiencia objetivo lo entienda. Para lograr e sto, se debe recurrir a todas las herramientas disponibles, como son analog as, guras y tablas.

El lector nunca tiene la culpa de no entender el mensaje,

componentes de un documento

La principal diferencia entre informes, publicaciones cient cas y trabajos de tesis es la audiencia. Mientras que los informes ser an leidos por un profesor o una audiencia limitada dentro de una unidad, las publicaciones y tesis estar an disponibles al publico en general. En t erminos estructurales, sin embargo, estos documentos dieren muy poco. Todos los componentes que se mencionan en esta seccion deber an ser incluidos a no ser que el profesor o la revista cient ca en particular indique lo contrario. 2.1 T tulo

El primer componente de un documento es el t tulo y ayuda a la audiencia a decidir, por ejemplo, entre descargar o no descargar un trabajo para una posible lectura. Los consejos para su elaboracion son los siguientes: consejo 1 : usar el menor numero de palabras que exprese el mensaje. En vez de escribir estudio de robots voladores para la medicion dricos, se podr a simplemente escribir de recursos h robots voladores para la mendicion dricos. En de recursos h general, se deben evitar palabras gen ericas como por ejemplo investigacion en. . . , comparacion entre. . . , etc. consejo 2 : colocar las palabras m as importantes al principio del t tulo. Si se quiere dar mayor e nfasis a los aspectos ingenieriles del trabajo mencionado con anterioridad, el orden de palabras del t tulo anterior es adecuado, pero si se quiere dar mayor e acos, se podr a cambiar a medicion nfasis a los aspectos geogr de recursos h dricos mediante robots voladores. consejo 3 : adecuar el t tulo a la audiencia. Si se esta enviando el trabajo a una revista de ingenieros el primer t tulo mencionado es adecuado, pero si se est a enviando el trabajo a una revista de geografos, el segundo t tulo mencionado es mejor. consejo 4 : elegir palabras que sean indexables por buscadores inform aticos. Es decir, no se recomienda la utilizacion de caract eres locales como, por ejemplo, la n del idioma espanol. 2.2 Resumen

El segundo, y quiz as m as importante, componente de un documento es el resumen ya que ayuda a la audiencia a decidir entre leer o no leer el trabajo. En algunas revistas cient cas se limita a 200 palabras y en otras a 500. En el resumen se deben evitar las referencias a otros trabajos y los pies de p agina; debe ser auto-contenido. Los consejos adicionales para su elaboracion son los siguientes: consejo 1 : describir brevemente qu e se hizo y porqu e se hizo. Esto provee el contexto del trabajo y en escencia es lo que ayuda a la audiencia a decidir si leer a o no leer a el trabajo. Por ejemplo, se podr a mencionar la problem atica de la medicion de recursos

h dricos en el altiplano chileno debido a la escasez de estaciones de muestreo (porqu e) y proponer un equipo de robots voladores para simplicar esta tarea mediante la adquision movil de datos geogr acos (qu e). consejo 2 : identicar brevemente los principales m etodos que se se hizo). Se podr a mencionar que, como un utilizaron (como primer paso, se simularon diez robots para estudiar los requerimientos comunicacionales o (si se avanzo as) que un poco m se construyeron diez prototipos b asicos de los robots utilizando una impresora 3D y una cortadora l aser. consejo 3 : mencionar brevemente los resultados m as signicativos. Si todo sale bien, se podr a proceder diciendo que los prototipos se coordinaron efectivamente unos con otros como queda demostrado en una serie de experimentos que se reportan en el documento. consejo 4 : mencionar brevemente las conclusiones m as signicaa concluir que es tivas. Con base en los resultados, se podr razonable continuar con el siguiente paso en la investigacion que podr a ser, por ejemplo, la adicion de sensores a los prototipos. consejo 5 : mantener el resumen corto y simple. 2.3 Introducci on

La introduccion as provee profundiza lo escrito en el resumen y adem el marco teorico necesario para entender lo que sigue en el documento. Como muchos lectores tienden a leer solo y la introduccion, el resumen hay que escribirla lo sucientemente atractiva para motivar la lectura de secciones subsiguientes. consejo 1 : describir la naturaleza y alcance del problema. Se debe profundizar en la explicacion e y proveer suciente del qu informacion para entender plenamente el problema. Cuando sea relevante, tambi en es conveniente dejar en claro para qui en se hizo el trabajo. En el caso de los informes, por ejemplo, el trabajo es simplemente un requerimiento del profesor. En algunos casos, tambi en es conveniente indicar lo que no se hizo en el presente trabajo. Por ejemplo, si se planea la publicacion secuencial de alguna investigacion, e es conveniente dejar en claro hasta qu punto se trabaja en esta publicacion e es lo que se deja para y qu publicaciones futuras. consejo 2 : explicar porqu e el trabajo es importante. Se deber a responder a las siguientes preguntas Porqu e el trabajo es necesario? Qu e problema resuelve? Qu e preguntas responde? Qu e procesos mejora? Qu e conclusiones contradice o soporta? Adem as, se deber a mencionar la audiencia objetivo del documento; por ejemplo, el trabajo tiene relevancia para todos los ingenieros, o solo ca? para aquellos trabajando en un a rea espec En este punto hay que dejar muy claro el mensaje y evitar magnicar la contribucion, por muy humilde que esta parezca. Es

mejor ser realistas con el lector que desilucionarlo despu es de haber le do la mayor parte del documento. consejo 3 : revisar la literatura relevante. En el caso de publicaciones y tesis, la inclusion de publicaciones rele de resumenes vantes, que describan el estado del arte del tema, provee terminolog a y as aclara la contribucion e). Adem as, del trabajo (qu expone el problema no resuelto y por ende tambi en aclara el porqu e del trabajo. Al momento de citar publicaciones hay que enfocarse en qu e se hizo y no en qui en la hizo. Es decir, en vez de escribir J. P erez et al. de la Universidad X tambi en estudiaron el problema, se deber a escribir este problema ya se estudio endose esto y esto otro [J. P erez de tal y tal forma obteni et al.]. consejo 4 : describir los m etodos que se utilizaron y, si es nece . Se debe profundizar la descripcion sario, justicar la eleccion de m etodos provista en el resumen pero no mucho ya que los detalles se dar an en las siguientes secciones. Se debe mencionar al menos el tipo de m etodo que se utiliza y, si existen m as formas de realizar el trabajo, se debe justicar la eleccion etodo de este m en particular. Si se escoge un m etodo por razones pragm aticas (e.g., falta de dinero), se debe ser honesto y decirlo. consejo 5 : mencionar los resultados m as importantes y las conclusiones (opcional). Algunas revistas permiten mencionar los resultados y conclusiones principales en e ste punto; lo cual permite al lector saber de antemano lo que se quiere demostrar en el documento. 2.4 M etodos

Esta seccion provee toda la informacion necesaria para reproducir los resultados que se presentar an en la seccion subsiguiente. Se enfoca en los procedimientos que se siguieron durante el trabajo y en los materiales que se utilizaron. consejo 1 : describir como se hizo el trabajo y qu e materiales se utilizaron para hacerlo. La idea es proveer la informacion suciente para que los resultados sean reproducibles; lo cual es la piedra angular del m etodo cient co. La profundidad de los detalles depender a de lo revolucionario del m etodo utilizado. Si se trata de un m etodo est andar, ser a suciente con referirse al m etodo por su nombre y con proveer una referencia. Por otra parte, si se trata de un m etodo nuevo o con elementos no-tradicionales, puede ser necesario dar detalles paso-a-paso. consejo 2 : usar pret erito si es necesario. Como se hace referencia a procedimientos ya efectuados, es recomendable acudir al pret erito cuando e sto ayude a aclarar la descripcion. consejo 3 : no describir los resultados. Se debe evitar a toda costa la tentacion de entregar y discutir los resultados, y dejarlos para la seccion subsiguiente.

 de m consejo 4 : mostrar la seccion etodos a colegas y preguntar sta. A veces, si podr an reproducir los resultados a partir de e resulta dif cil para los autores evaluar la claridad de sus propios p arrafos; si un colega no entiende, aclararlo de forma escrita y no verbal. No olvidar que la responsabilidad es plenamente del escritor; no del lector. 2.5 Resultados

Este cap tulo presenta los resultados del trabajo y valida las futuras conclusiones. consejo 1 : presentar los resultados claramente. Para e sto, utilizar una o m as tablas. Dependiendo de la audiencia, se podr a presentar solo un resumen de los resultados y proveer el data set completo en un ap endice. consejo 2 : usar pret erito si es necesario. Como se hace referencia a resultados ya obtenidos, es recomendable acudir al pret erito cuando e sto ayude a aclarar la descripcion. consejo 3 : no interpretar los resultados. Evitar la tentacion de interpretar el signicado de curvas y estad sticas en esta seccion. 2.6 Discusi on

consejo 1 : interpretar los resultados individualmente. Se debe esperar hasta las conclusiones para juntar todas estas interpretaciones en una solida conclusion o recomendacion. consejo 2 : no excluir problemas que aparezcan en los resultados. Muchas veces, curvas inesperadas en los datos resultan ser el aporte m as importante de la investigacion. Si aparece algo que no se logra explicar o entender, se debe ser sincero y decirlo. consejo 3 : relacionar las interpretaciones con el mensaje. Es muy conveniente permitir que el lector visualice claramente la relacion entre las interpretaciones de los resultados y el mensaje o gran conclusion a presetada en secciones subsiguientes. que ser 2.7 Conclusi on

Puede ser el ultimo p arrafo de las discusiones. De separase en una seccion independiente, se suele comenzar con un pequeno resumen del documento en pret erito. Los consejos para su elaboracion son los siguientes: consejo 1 : sintetizar las discusiones en una o m as conclusiones. Si se estaba analizando una hipotesis, los resultados la sopor tan? Si los resultados fueron coherentes con las expectativas, qu e conclusiones se pueden hacer? Se puede generalizar la conclusion as amplia? a un a rea de estudio m

consejo 2 : no temer a sacar conclusiones negativas. Las conclusiones negativas contribuyen tanto como las conclusiones positivas. No encontrar una relacion entre X e Y puede ser tan o m as importante que escontrar dicha relacion. Las mejores revistas cient cas no tendr an problemas en aceptar trabajos que demuestren una forma de no hacer las cosas. 3 cnica gram atica te

En la escritura t ecnica lo m as importante es la claridad del mensaje. Por lo mismo, se podr a argumentar que el idioma espanol no es el m as adecuado para esta labor ya que, al proveer completa libertad de redaccion, aticas los escritores tienden a probar combinaciones gram para embellecer las frases. El idioma ingl es, al contrario, sigue reglas concretas que permiten a los escritores poner m as atencion al contenido que a las formas gram aticas [3]. Las siguientes secciones hacen referencia a reglas del idioma anglosajon debido a que su aplicacion a documentos en espanol as claros (aunque no resulta en mensajes m necesariamente m as bellos). 3.1 [Algunos] tipos de frases

Una oracion a compuesta por una o m as es una idea completa que est frases. Las siguientes secciones muestran algunos tipos de frases que se deben conocer para puntuar correctamente oraciones y listas. 3.1.1 Frases completas

Una frase completa tiene por lo menos un sujeto y un verbo. Una frase completa puede llegar a ser una oracion. Ejemplos de frases completas son: Valentina llora. El jefe est a cantando. [Tu] quieres salir? Mary y Andrea comprar an los componentes. Pedro no ha construido la repisa de las herramientas. Ejemplos de frases no-completas (o fragmentos) son: El jefe cantando (cantando es gerundio); El auto chocado por el bus (chocado [por el bus] es adjetivo); y Ver para creer (ver y creer son innitivos). 3.1.2 Frases independientes y subordinadas

Algunas oraciones est an formadas por dos tipos de frases: independientes y subordinadas. La frase independiente tiene sentido sin la subordinada, pero esta ultima no tiene sentido sin la independiente. Algunos de ejemplos de oraciones compuestas por estos dos tipos de frases son:

1. frase independiente : Ricardo se tomo la sopa. frase subordinada : Despu es de un arduo d a de trabajo. completa : Ricardo se tomo oraci on es de un la sopa despu arduo d a de trabajo. 2. frase independiente : Daniel desarrollo su tesis. frase subordinada : Porque [ el] quer a empezar a ganar dinero. completa : Daniel desarrollo oraci on a su tesis porque quer empezar a ganar dinero. 3.2 Uso de la coma; ,

Las siguientes secciones hacen referencia a los conceptos antes mencionados para ensenar el correcto uso de la coma. 3.2.1 Conjugaciones coordinantes; y, e, o, u, sino, pero.

Las conjunciones coordinantes unen frases o palabras de un mismo nivel sint actico. Si las conjugaciones coordinantes unen dos frases completas, e stas son precedidas por coma como se muestra en los siguientes ejemplos: Valentina llora por su hija, pero Jade no llora por su madre. El jefe esta cantando, y la secretaria sigue trabajando. Al contrario, si las conjugaciones coordinantes unen sustantivos, verbos, adjetivos, etc., e stas no son precedidas por coma como se muestra en los siguientes ejemplos: Valentina grita y llora por su hija. El jefe esta cantando y saltando en la esta. 3.2.2 Conjugaciones subordinantes; mientras, debido, porque aunque, desde, cuando, donde, si, antes, despu es, hasta, etc.

Las conjunciones subordinantes proveen informacion acerca del tipo de relacion que tienen las frases que e stas unen. En general no van precedidas por coma incluso si unen a dos frases completas. Los ejemplos de la Sec. 3.1.2 muestran la utilizacion de algunas conjugaciones subordinantes. El siguiente es un ejemplo adicional: se pre Juanito se preocupo de festejar mientras sus companeros ocupaban de estudiar. Por otra parte, si se utilizan frases subordinadas al principio de una oracion, e stas van seguidas por coma; y si se encuentran en medio de una oracion, en van encerradas a modo de frase explicativa, e stas tambi por comas. Los siguientes ejemplos muestran las situaciones antes mencionadas. frase independiente : El robot funciono a la perfeccion en la competencia.

frase subordinada : Debido a que el grupo trabajo organizadamente. completa : Debido a que el grupo trabajo oraci on organizadamente, el robot funciono a la perfeccion en la competencia. frase independiente : El artista gano el concurso internacional. frase subordinada : Gracias a su esfuerzo y dedicacion. completa : El artista, gracias a su esfuerzo y dedicacion, oraci on gano el concurso internacional. 3.3 Puntuaci on de listas

Existen b asicamente tres tipos de listas: listas simples, listas de fragmentos, y listas de frases completas, y para cada una se utilizan reglas de puntuacion diferentes [2]. 3.3.1 Listas simples

Las listas simples, con vinetas o enumeradas, est an compuestas de palabras o frases muy cortas. En este caso los elementos se escriben con minuscula, no hay puntuacion al nal de cada palabra, y se utiliza un doble punto (:) al nal del texto introductorio. Un ejemplo de este tipo de lista se muestra a continuacion. Necesitamos los siguientes materiales: papel A4 tijeras corchetera l apices 3.3.2 Listas de fragmentos

Las listas de fragmentos est an compuestas de frases no-completas. En este caso, todos los elementos de la lista comienzan con minuscula y llevan un punto y coma (;) al nal; con la excepcion del penultimo elemento que adem as lleva una conjuncion y o e, y el ultimo elemento que lleva un punto aparte. Un ejemplo de este tipo de lista se muestra a continuacion. El entrenamiento contribuye a la efectividad organizacional de las siguientes formas: corrigiendo deciencias en las habilidades; desarrollando una fuerza de trabajo exible y adaptable; e incrementando el compromiso del trabajador.

3.3.3

Listas de frases completas

En las listas de frases completas cada elemento comienza con mayuscula y termina con un punto aparte. Un ejemplo de este tipo de lista se muestra a continuacion. El entrenamiento contribuye a la efectividad organizacional de las siguientes formas: Las deciencias en las habilidades son corregidas. Una fuerza de trabajo exible y adaptable es desarrollada. El compromiso del trabajador se incrementa. 4 conclusi on

Se entregaron consejos pr acticos que buscan mejorar la calidad de los informes, las publicaciones y las tesis de los estudiantes de la Escuela Universitaria de Ingenier a Mec anica de la Universidad de Tarapac a. Se espera que el documento sirva de gu a durante la elaboracion de todos los informes presentados a lo largo de la carrera, por lo cual se buscar a ocializar su adopcion a nivel de jefatura de carreras. references [1] Tim North. Writing Scientic Papers and Technical Reports. Scribe Consulting, November 2007. [2] Tim North. Editing and proofreading. Scribe Consulting, January 2009. [3] Geraldine Woods. English Grammar for Dummies. For Dummies, 2nd edition, February 2010.