ESCRIBIENDO INFORMES,

PUBLICACIONES Y TESIS
Propuesta estructural, de contenidos, y gram
atica de la
Escuela Universitaria de Ingeniera Mec
anica de la
Universidad de Tarapac
a

ricardo franco mendoza garci a

Escuela Universitaria de Ingeniera Mecanica
Universidad de Tarapaca, Arica, Chile
rmendozag@uta.cl

March 12, 2013

Debido a un requerimiento institucional, se entregan consejos practicos para la elaboracion

de informes, publicaciones
cientficas y tesis de los estudiantes de la Escuela Universitaria de Ingeniera Mecanica de la Universidad de Tarapaca.
Se trata de una receta extrada de libros y cursos de escritura que se enfoca en la estructura, los contenidos y la
gramatica tecnica, y que ha probado ser efectiva en las
publicaciones de algunos academicos de la unidad.
contents
1 Introduccion
2

1.1 El mensaje, lo mas 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 Ttulo
4
2.2 Resumen
4
2.3 Introduccion
5

2.4 Metodos
6
2.5 Resultados
7
2.6 Discusion
7

2.7 Conclusion
7

3 Gramatica Tecnica
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, despues, 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

3.2.2

References
1

11

introducci on

El siguiente documento pretende inicialmente servir de gua para la

estructuracion
de informes, publicaciones cientficas y tesis de grado
de los estudiantes de la Escuela Universitaria de Ingeniera Mecanica
de la Universidad de Tarapaca1 . Nace debido a un requerimiento de
las autoridades de la Escuela que busca inculcar en los estudiantes la
capacidad de comunicar ideas tecnicas 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 Scientific
Papers and Technical Reports [1] complementados por los conceptos
entregados en el curso Writing Scientific Papers in English impartido
por el Maersk McKinney Moller Institute2 . Se entrega esta receta debido
a la mejora que ha significado en el porcentaje de aceptacion
de las
publicaciones en ingles de algunos academicos de la Escuela.
Aunque el documento se enfoca principalmente en la estructuracion

de los documentos antes mencionados, tambien se entregan algunos

consejos referentes a el contenido, la gramatica tecnica y el formato
tpico de las publicaciones cientficas. La ortografa esta fuera del
alcance de este trabajo.
El mensaje, lo mas importante

1.1

El proceso de escritura se facilita mucho y fluye 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
cientficas y tesis.

1.1.1

Contribucion 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

El proceso de
escritura se facilita si
se tiene claro el
mensaje del
documento.

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
de una teora o dispositivo innovador;
una teora conocida puede ser aplicada a
un analisis de como

una nueva situacion

o dominio;
una prueba tangible de un concepto innovador;
un re-analisis de un trabajo existente o su replicacion
con variaciones menores;
una investigacion
de como un metodo especfico se comporta en
frente a una evaluacion
estandar; o
una comparacion
entre dos metodos (uno de ellos puede ser una
propuesta personal).
1.2

La audiencia

El objetivo ultimo
de un documento escrito es que la audiencia, o

lector final, entienda el mensaje. Si e sto no ocurre, puede que un gran

descubrimiento cientfico 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
cientfica a un
experto en la materia y a una abuelita, a quien se le debe dedicar
mas 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 sera 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

Adecuacion

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
de los aspectos tecnicos para los
veterinarios y en la de los aspectos biologicos
para los ingenieros.

1.2.3

Es conveniente
asumir que la

audiencia seran
estudiantes de
primer o segundo
en la materia.
ano

Responsabilidad

Se debe tener claro que el lector nunca tiene la culpa de no entender

el mensaje; es el escritor quien debe poner mas 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 analogas, figuras y tablas.

El lector nunca tiene

la culpa de no
entender el mensaje,

componentes de un documento

La principal diferencia entre informes, publicaciones cientficas y

trabajos de tesis es la audiencia. Mientras que los informes seran
leidos por un profesor o una audiencia limitada dentro de una unidad,
las publicaciones y tesis estaran disponibles al publico
en general.

En terminos estructurales, sin embargo, estos documentos difieren

muy poco. Todos los componentes que se mencionan en esta seccion

deberan ser incluidos a no ser que el profesor o la revista cientfica

en particular indique lo contrario.
2.1

Ttulo

El primer componente de un documento es el ttulo 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
de recursos hdricos, se podra simplemente escribir
robots voladores para la mendicion
de recursos hdricos. En
general, se deben evitar palabras genericas como por ejemplo
investigacion
en. . . , comparacion
entre. . . , etc.
consejo 2: colocar las palabras mas importantes al principio del
ttulo. Si se quiere dar mayor e nfasis a los aspectos ingenieriles
del trabajo mencionado con anterioridad, el orden de palabras
del ttulo anterior es adecuado, pero si se quiere dar mayor
e nfasis a los aspectos geograficos, se podra cambiar a medicion

de recursos hdricos mediante robots voladores.

consejo 3: adecuar el ttulo a la audiencia. Si se esta enviando el
trabajo a una revista de ingenieros el primer ttulo mencionado
es adecuado, pero si se esta enviando el trabajo a una revista de
geografos,
el segundo ttulo mencionado es mejor.

consejo 4: elegir palabras que sean indexables por buscadores informaticos. Es decir, no se recomienda la utilizacion
de caracteres locales como, por ejemplo, la n
del idioma espanol.

2.2

Resumen

El segundo, y quizas mas 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 cientficas 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 pagina; debe ser auto-contenido. Los consejos
adicionales para su elaboracion
son los siguientes:

consejo 1: describir brevemente que se hizo y porque se hizo. Esto

provee el contexto del trabajo y en escencia es lo que ayuda a la
audiencia a decidir si leera o no leera el trabajo. Por ejemplo, se
podra mencionar la problematica de la medicion
de recursos

hdricos en el altiplano chileno debido a la escasez de estaciones de muestreo (porque) y proponer un equipo de robots
voladores para simplificar esta tarea mediante la adquision
movil

de datos geograficos (que).

consejo 2: identificar brevemente los principales metodos que se
se hizo). Se podra mencionar que, como un
utilizaron (como

primer paso, se simularon diez robots para estudiar los requerimientos comunicacionales o (si se avanzo un poco mas) que
se construyeron diez prototipos basicos de los robots utilizando
una impresora 3D y una cortadora laser.
consejo 3: mencionar brevemente los resultados mas significativos.
Si todo sale bien, se podra 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 mas significativas. Con base en los resultados, se podra concluir que es
razonable continuar con el siguiente paso en la investigacion

que podra ser, por ejemplo, la adicion

de sensores a los prototipos.
consejo 5: mantener el resumen corto y simple.
2.3

Introduccion

La introduccion
profundiza lo escrito en el resumen y ademas provee
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 suficientemente atractiva para motivar la lectura

de secciones subsiguientes.
consejo 1: describir la naturaleza y alcance del problema. Se debe
profundizar en la explicacion
del que y proveer suficiente
informacion
para entender plenamente el problema. Cuando sea
relevante, tambien es conveniente dejar en claro para quien se
hizo el trabajo. En el caso de los informes, por ejemplo, el trabajo
es simplemente un requerimiento del profesor. En algunos casos,
tambien es conveniente indicar lo que no se hizo en el presente
trabajo. Por ejemplo, si se planea la publicacion
secuencial de
alguna investigacion,
es conveniente dejar en claro hasta que
punto se trabaja en esta publicacion
y que es lo que se deja para
publicaciones futuras.
consejo 2: explicar porque el trabajo es importante. Se debera
responder a las siguientes preguntas Porque el trabajo es necesario? Que problema resuelve? Que preguntas responde?
Que procesos mejora? Que conclusiones contradice o soporta?
Ademas, se debera mencionar la audiencia objetivo del documento; por ejemplo, el trabajo tiene relevancia para todos los
ingenieros, o solo
para aquellos trabajando en un a rea especfica?
En este punto hay que dejar muy claro el mensaje y evitar magnificar la contribucion,
por muy humilde que esta parezca. Es

mejor ser realistas con el lector que desilucionarlo despues de

haber ledo 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 terminologa y as aclara la contribucion
del trabajo (que). Ademas,
expone el problema no resuelto y por ende tambien aclara el
porque del trabajo. Al momento de citar publicaciones hay que
enfocarse en que se hizo y no en quien la hizo. Es decir,
en vez de escribir J. Perez et al. de la Universidad X tambien
estudiaron el problema, se debera escribir este problema ya se
estudio de tal y tal forma obteniendose esto y esto otro [J. Perez
et al.].
consejo 4: describir los metodos que se utilizaron y, si es nece Se debe profundizar la descripcion
sario, justificar la eleccion.

de metodos provista en el resumen pero no mucho ya que los

detalles se daran en las siguientes secciones. Se debe mencionar
al menos el tipo de metodo que se utiliza y, si existen mas formas
de realizar el trabajo, se debe justificar la eleccion
de este metodo
en particular. Si se escoge un metodo por razones pragmaticas
(e.g., falta de dinero), se debe ser honesto y decirlo.
consejo 5: mencionar los resultados mas 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

Metodos

Esta seccion
provee toda la informacion
necesaria para reproducir los
resultados que se presentaran 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 que materiales se
utilizaron para hacerlo. La idea es proveer la informacion
suficiente para que los resultados sean reproducibles; lo cual es
la piedra angular del metodo cientfico. La profundidad de los
detalles dependera de lo revolucionario del metodo utilizado. Si
se trata de un metodo estandar, sera suficiente con referirse
al metodo por su nombre y con proveer una referencia. Por
otra parte, si se trata de un metodo nuevo o con elementos
no-tradicionales, puede ser necesario dar detalles paso-a-paso.
consejo 2: usar preterito si es necesario. Como se hace referencia a procedimientos ya efectuados, es recomendable acudir al
preterito 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 metodos a colegas y preguntar

consejo 4: mostrar la seccion
si podran reproducir los resultados a partir de e sta. A veces,
resulta difcil para los autores evaluar la claridad de sus propios
parrafos; 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 captulo presenta los resultados del trabajo y valida las futuras
conclusiones.
consejo 1: presentar los resultados claramente. Para e sto, utilizar
una o mas tablas. Dependiendo de la audiencia, se podra
presentar solo
un resumen de los resultados y proveer el data set
completo en un apendice.
consejo 2: usar preterito si es necesario. Como se hace referencia
a resultados ya obtenidos, es recomendable acudir al preterito
cuando e sto ayude a aclarar la descripcion.

consejo 3: no interpretar los resultados. Evitar la tentacion

de
interpretar el significado de curvas y estadsticas en esta seccion.

2.6

Discusion

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 mas 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
que sera presetada en secciones subsiguientes.
2.7

Conclusion

Puede ser el ultimo

parrafo de las discusiones. De separase en una

seccion
independiente, se suele comenzar con un pequeno
resumen
del documento en preterito. Los consejos para su elaboracion
son los
siguientes:
consejo 1: sintetizar las discusiones en una o mas conclusiones.
Si se estaba analizando una hipotesis,
los resultados la sopor
tan? Si los resultados fueron coherentes con las expectativas,
que conclusiones se pueden hacer? Se puede generalizar la
conclusion
a un a rea de estudio mas amplia?

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 mas importante que escontrar dicha relacion.
Las mejores

revistas cientficas no tendran problemas en aceptar trabajos que

demuestren una forma de no hacer las cosas.
3

gram atica
t e cnica

En la escritura tecnica lo mas importante es la claridad del mensaje.

Por lo mismo, se podra argumentar que el idioma espanol
no es el
mas adecuado para esta labor ya que, al proveer completa libertad de
redaccion,
los escritores tienden a probar combinaciones gramaticas
para embellecer las frases. El idioma ingles, al contrario, sigue reglas
concretas que permiten a los escritores poner mas atencion
al contenido que a las formas gramaticas [3]. Las siguientes secciones hacen
referencia a reglas del idioma anglosajon
debido a que su aplicacion

a documentos en espanol
resulta en mensajes mas claros (aunque no
necesariamente mas bellos).
[Algunos] tipos de frases

3.1

Una oracion
es una idea completa que esta compuesta por una o mas
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 esta cantando.
[Tu] quieres salir?
Mary y Andrea compraran 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 infinitivos).
3.1.2

Frases independientes y subordinadas

Algunas oraciones estan 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: Despues de un arduo da de trabajo.
completa: Ricardo se tomo la sopa despues de un
oraci on
arduo da de trabajo.
2. frase independiente: Daniel desarrollo su tesis.
frase subordinada: Porque [el] quera empezar a ganar dinero.
completa: Daniel desarrollo su tesis porque quera
oraci on
empezar a ganar dinero.
Uso de la coma; ,

3.2

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 sintactico. 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 fiesta.
3.2.2

Conjugaciones subordinantes; mientras, debido, porque aunque,

desde, cuando, donde, si, antes, despues, 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,
a modo de frase explicativa, e stas tambien van encerradas
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 organizadaoraci on
mente, 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.

Puntuacion de listas

3.3

Existen basicamente 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, estan compuestas de

palabras o frases muy cortas. En este caso los elementos se escriben

con minuscula,
no hay puntuacion

al final de cada palabra, y se utiliza

un doble punto (:) al final del texto introductorio. Un ejemplo de
este tipo de lista se muestra a continuacion.

Necesitamos los siguientes materiales:

papel A4
tijeras
corchetera
lapices
3.3.2

Listas de fragmentos

Las listas de fragmentos estan compuestas de frases no-completas. En

este caso, todos los elementos de la lista comienzan con minuscula
y

llevan un punto y coma (;) al final; con la excepcion

del penultimo

elemento que ademas 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 deficiencias en las habilidades;
desarrollando una fuerza de trabajo flexible 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 deficiencias en las habilidades son corregidas.
Una fuerza de trabajo flexible y adaptable es desarrollada.
El compromiso del trabajador se incrementa.
4

conclusi on

Se entregaron consejos practicos que buscan mejorar la calidad de los

informes, las publicaciones y las tesis de los estudiantes de la Escuela
Universitaria de Ingeniera Mecanica de la Universidad de Tarapaca.
Se espera que el documento sirva de gua durante la elaboracion
de
todos los informes presentados a lo largo de la carrera, por lo cual se
buscara oficializar su adopcion
a nivel de jefatura de carreras.
references
[1] Tim North. Writing Scientific 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.