Escudo
Colegio Oficial de Ingenieros Técnicos y Grados en Minas y Energía de Madrid
Ávila Cuenca Guadalajara Salamanca Segovia Toledo Valladolid Zamora

Consejos de escritura para Ingenieros y Grados

-.Consejos prácticos sobre cómo escribir para ingenieros (proyectos, tesis, trabajos de investigación

 

La versión original de este documento (la que se puede citar) es:

http://riunet.upv.es/bitstream/handle/10251/18355/Consejos%20de%20Escriturav6.pdf?sequence=1&isAllowed=y

CONSEJOS PARA LA ESCRITURA DE PROYECTOS, TESIS Y TRABAJOS DE INVESTIGACIÓN.

José Pedro García Sabater

El presente documento lo he ido desarrollando a partir de la experiencia personal y de los proyectos y trabajos que he dirigido en los últimos años. Mis profesores de lengua nunca me corrigieron porque “cada escritor tiene su estilo”.

Mi experiencia personal me ha demostrado que cada escritor tiene con suerte un estilo o más probablemente ninguno.

Desgraciadamente en todos estos años de educación, a la mayor parte de nosotros nadie nos ha enseñado cómo escribir textos técnicos(en ocasiones no hemos sido siquiera capaces de aprender a no cometer faltas de ortografía). Leía recientemente que escribimos de modo barroco porque en el colegio nos dieron de leer al Siglo de Oro Español. Y aunque el barroco ya no es el género predominante, nunca nadie nos dijo que ese no era el modo de escribir.

Este documento pretende servir de ayuda en el trabajo de escribir y maquetar el trabajo que tienes por delante. Los puntos no tienen un orden predefinido, ya que no es un texto que hay que aprenderse, sólo aspira a ayudar.

La mayor parte de mis alumnos se quejan de que sólo mire las formas. No es cierto. Me interesa el contenido. Pero, como ya anticipara McLuhan, “el medio (la forma) es el mensaje”. Y sí, yo también soy hijo de mi tiempo, si veo que alguien no ha perdido 5 minutos en maquetar un documento considero que yo no tengo porqué perder 10 minutos intentando descifrar el inicio de su estructura

La mayor parte de los revisores de textos técnicos o científicos no tienen tiempo para leer todo el documento desde el principio hasta el final. Leen primero un abstract si lo hay, luego las conclusiones. Si estas les interesan leen la introducción que les indicará a qué capítulo han de ir para seguir interesándose. Si no son capaces de seguir esta secuencia (porque el formato no ayuda) el contenido nunca será leído. Y evidentemente nunca será bien valorado.

Asegúrate de que nadie cae en la tentación de no leer tu trabajo, simplemente porque no perdiste un poco de tiempo en estructurarlo y maquetarlo bien.

A.1 General

1) El uso del ordenador no esquiva el trabajo de creación que supone hacer un documento largo y propio. Es fundamental pensar antes de escribir.

2) Aunque tengamos ya muchas cosas hechas en el disco duro, si simplemente las mezclamos en el documento, cualquiera se dará cuenta que sólo las hemos mezclado.

3) Los trabajos técnicos y científicos no son novelas. Las reflexiones se deben apoyar en trabajos ajenos y no en nuestra percepción de nuestro mundo interior.

4) Copiar de uno es plagio. Copiar de muchos se denomina investigación. Y en cualquier caso citar la fuente no sólo es signo de respeto sino que es una obligación.

5) Establece desde el principio un método para citar bibliografía, y úsalo para citar tus fuentes.. De hecho lo mejor es que utilices una herramienta de referencia bibliográfica como Reference Manager, RefWorks o Zotero.

6) Elige un modo de dirigirte al lector desde el principio y mantenlo. El más recomendable es el uso de la voz reflexiva (se presenta a continuación), aunque es también útil la primera persona del plural (presentamos a continuación). No es tan recomendable la primera del singular (presento a continuación). Es interesante elegirlo desde el principio, porque en caso contrario es muy difícil de cambiar.

7) Generalmente un trabajo busca una solución a un problema: Antes de plantear la solución plantea tres o cuatro alternativas.

8) Antes de explicar las alternativas, hay que escribir y describir el problema.

A.2 ¿qué es un proyecto?

9) Un proyecto no es la documentación de una implantación ya realizada. Tampoco es una novela, ni ningún genero literario de consumo general.

10) Un proyecto es una propuesta de solución, de entre varias, que probablemente solucionan un problema que probablemente existe.

11) ¿Cómo se sabe que el problema existe? Porque se analiza la realidad (con datos). Eso es la descripción del problema (de la empresa, de la industria…)

12) ¿Cómo se sabe que se puede solucionar el problema? Porque se hace referencia a lo que otros han hecho para resolverlo. Eso es el estado del arte o de la cuestión. Describe teóricamente el problema.

13) Para resolver el problema se plantean alternativas. Y hay que seleccionar una.

14) El proyecto posteriormente describe con detalle la alternativa seleccionada, cuantifica su coste, establece un calendario. En algunos casos incluso establece cómo se sabrá que se ha resuelto el problema.

15) Así pues, ¿de qué consta un proyecto?

a) Introducción.

b) Descripción del entorno y del Problema

c) Estado de la cuestión. Revisión Teórica

d) Planteamiento de Alternativas y Selección.

e) Diseño detallado de la solución.

f) Presupuesto.

g) Plan de Implantación.

A.3 Pragmática Textual

16) Evita, en la medida de lo razonable, el abuso de frases subordinadas y coordinadas (el llamado estilo hipotáctico). Evidentemente no es erróneo su uso, pero, para que el castellano que utilices sea inteligible, deberás trabajar mucho. Y es más fácil hacer frases cortas coordinadas (estilo paratáctico). En realidad al principio es más difícil, pero poco a poco serás capaz de ir estirando la longitud de las frases.

17) Insisto, las frases no deben ser excesivamente largas. Al menos no tanto como ésta:

Mala calidad en la presentación de los documentos en los tablones de la planta, ya que de tanto hacer fotocopias los master están dañados, todo esto es algo muy negativo ya que influye en la calidad y estética de la planta, cosa que con el nuevo coche debe de cambiarse ya que lo que se busca es una apertura de la factoría cara al publico, ya que según las nuevas filosofías y pensamientos de Jaguar, la gente que compra un coche del estatus del Jaguar tiene que tener derecho a ver como es el proceso de realización de su coche, y como no, el interior y estado de la planta es un punto muy importante que debe de controlarse, ya que es la cobertura de donde se va a encontrar el nuevo coche, con lo que todos los detalles deben de controlarse al mínimo para satisfacer los gustos y necesidades de todas las personas más exigentes

18) En el caso anterior no cito la fuente, porque no creo que la fuente quiera ser citada.

19) El corrector ortográfico del microchoff word es peligroso. “Hay esta la baca” es ortográficamente correcto, pero “Ahí está la vaca” está bien.

20) No utilices aumentativos sin motivo pues queda excesivamente coloquial. (Esto es importantísimo se puede escribir Esto es especialmente importante).

21) No se debe escribir que se demuestra algo, si no hay una demostración (matemática o al menos lógica). Es mejor escribir que se muestra algo. Es menos arriesgado.

22) No se debe utilizar la palabra optimizar en vano.

23) Escribir un trabajo de investigación, no es hacer literatura barroca. Cada frase y cada palabra debe servir para algo. Si no limitamos nuestra verborrea, nos podemos meter en un lío.

24) La estructura de una frase corta es Sujeto y Predicado, y en ese orden mejor. Incluso se puede admitir que en el predicado primero va el verbo seguido del objeto directo, luego el indirecto y por último los complementos circunstanciales (por lo menos en otros idiomas nos enseñan que es así, no veo porqué en castellano no).

25) Como a partir de ahora vas a tener que poner mucho de tu parte propongo dos o tres reglillas que personalmente utilizo y funcionan bastante bien y por eso te las escribo: Escribe con frases cortas que se puedan leer sin parar, es decir no te enrolles mucho, simplemente di lo que tengas que decir, el método en este caso es sencillo , deberías pensar un un poco antes de empezar a escribir y si, para ello, debes escribirlo primero en un papel – sí un papel- aunque sea muy resumido, hazlo, y luego ponlo en el ordenador sin intentar hacer rollos superlargos, con muchas repeticiones, es decir diciendo siempre lo mismo, y donde pretendas que esté toda la información, sin puntos en medio, con pocas comas y todo eso, no clasifiques cosas sin sentido, y evita en la medida de lo posible enumerar cosas que no tienen número de orden o que no están completas.

26) Como vas a tener que escribir mucho y ha de ser tuyo, te adjunto unas reglillas que utilizo. Por lo menos a mí me van muy bien. Decide qué vas a escribir, y luego escríbelo. Escribe frases cortas. Al principio cuesta, pero luego es fácil. No intentes ponerlo todo en el mismo párrafo. Ve paso a paso. No hagas clasificaciones incompletas, ni enumeraciones sin orden.

27) En los dos párrafos anteriores pone lo mismo. En uno no se entiende nada, en el otro sí. ¿Adivinas en cual?

28) Hacer frases cortas. No es distribuir aleatoriamente. Puntos por el texto.

29) No escribas en tono coloquial. Hace cuatro puntos tienes un ejemplo de qué es lo que no has de hacer.

30) Si se va a hacer una descripción de, por ejemplo, 7 etapas de algo, no está de más, primero listarlas y luego iniciar la descripción.

31) La construcción en pasiva es típicamente inglesa y su abuso denota que estás traduciendo algo (lo cual no es pecado si dices de quien lo traduces). Lo mejor es escribir en castellano. Ejemplo: “Puede que sean retrasadas…” se debería escribir “Pueden retrasarse” o “puede que se retrasen”.

32) Las palabras o construcciones en otro idioma debieran ir al menos en cursiva, y no estaría de más que la traducción estuviera a pie de página, o traducida en un glosario.

A.4 Cómo empezar

33) No te preocupes por el volumen, porque éste llegará más pronto o más tarde. Tú tienes un proyecto, escríbelo.

34) Antes de ponerte a escribir, haz a mano un resumen de 10 líneas con lo que quieres decir en el documento.

35) Antes de empezar un capítulo escribe una breve introducción. Ésta debe ser un resumen de lo que vas a escribir. Si el resumen no te sale fácil es que al capítulo le faltan o sobran cosas (ponlas o quítalas).

36) La misma regla anterior vale para cada apartado.

37) El orden en el que queda el documento no es necesariamente el orden en el que se han ejecutado las actividades.

38) Word tiene una utilidad muy interesante: la posibilidad de ver en formato esquema. Aprende a usarla antes de empezar. http://www.youtube.com/watch?v=GCe18oRsCSU

39) Es también interesante conocer que se pueden definir estilos. Y que algunos, como los de título, están ya definidos.

40) Escribir un PFC, o un trabajo cualquiera, es como contar una historia. Debes ir paso a paso, sin irte por las ramas, pero teniendo bien seguro que todo el mundo sabe de que hablas. De hecho en los otros proyectos ocurre lo mismo. Si vas a contar que quieres soldar una aleta, tendrás que asegurarte que el lector sabe que es soldar (y si hay otras opciones, como atornillar..) , qué es una aleta (donde está, para qué sirve), y además tendrás que explicar como se suelda ( y si hay otras opciones en el soldado). Y así poco a poco.

41) Un buen documento debe permitir que su índice sea inteligible. Un buen documento con índice indescifrable no será leído.

42) Si te agobia un documento demasiado largo, haz los capítulos en archivos separados. Ponles numeración independiente de páginas y de figuras. Así podrás ir acabando e imprimiendo capítulos con lo que te sentirás más satisfecho.

43) Para numerar las páginas del capítulo puedes utilizar la siguiente regla: Pon 2.13 donde 2 es el numero del capítulo y 13 el número de la página.

A.5 Maquetar

44) No escribas con letra grande, no ganas muchas hojas, y tampoco da buena impresión. Ni tampoco es necesario poner mucho interlineado.

45) Un trabajo gordo no es necesariamente un buen trabajo. Un trabajo fino, no es necesariamente un mal trabajo.

46) Si pones gráficos, figuras y fotos sólo para rellenar siempre se nota demasiado.

47) Los gráficos y las figuras deben ir con un título bajo de ellas e indicando la fuente.

Ejemplo Figura 2.13 El esquema de la factoría. (Fuente: Elaboración Propia)

48) Los gráficos y figuras deben ir referenciados en el texto, o no ir.

49) No insertes imágenes flotantes, luego son muy difíciles de maquetar.

50) No dibujes sobre el word. Es mejor dibujar lo que quieras sobre powerpoint, y pegarlas como imagen.

51) No empieces párrafos con blancos y cosas así, porque luego maquetar te será muy difícil. Utiliza los tabuladores. Lo mismo es aplicable a poner muchos saltos de línea.

52) Al hacer una enumeración es interesante utilizar números o símbolos, modificando el inicio del párrafo para que quede más claro.

Ejemplo

Okamura y Yamashita definen 4 etapas en la gestión de una línea de montaje, que se describen a continuación:

1) Definición del tiempo de ciclo

2) Estandarización de tareas

3) Equilibrado de Líneas

4) Secuenciación de la producción.

El Tiempo de Ciclo, es el tiempo disponible para la producción dividido por la cantidad de unidades a producir. Fija la capacidad del sistema.

La Estandarización de Tareas es la (…)

53) No asumas que todo el mundo domina cosas que sólo conoces tú. Si realmente crees que no es relevante, llévatelo a un anexo. Si sí es relevante ponlo en el capítulo. En ocasiones es interesante hacer un glosario.

54) Por regla general no pongas líneas en blanco entre párrafos. Si quieres aumentar el espaciado utiliza el formato párrafo. En cualquier caso no sirve de nada, el poco aumento de volumen que consigues es más fácil de conseguir con imágenes un poco más grandes. Y la imagen que se da es de relleno inútil.

55) Admitiendo todas las ventajas de la herramienta “microchoff word”, no es un buen “maquetador” de texto e imagen. Cuando se quiera hacer algo “extraño” con el texto, como por ejemplo poner una fórmula en letras, lo mejor es hacerlo en Power Point y luego copiarlo como imagen. Ejemplo:

56) Aunque hacer un trabajo no es hacer una revista, un poco de maquetado nunca viene mal, cosas como cambiar el tipo de letra dependiendo del nivel del título, o incluso forzar un salto de página a tiempo son aspectos a tener en cuenta.

57) La vista esquema del word facilitará el trabajo de revisar el orden de los puntos.

58) En ocasiones la cantidad de datos a expresar es muy alta, para esto se ha inventado pasar los datos a anexos, y resumirlos en forma de gráficos en el texto principal. NO es buena solución simplemente decir que hay muchos y por tanto no decir ninguno.

59) Word permite hacer tablas de contenido (generalmente conocidas como índices) muy fácilmente. Aprender a usarlos no es difícil.

60) Como tampoco es difícil poner encabezados y pies de página.

61) Si hay que listar datos, es interesante ponerlos en forma de tablas cuidando que no llenen hojas en blanco, gracias a los interlineados y a los puntos del párrafo antes y después.

62) Un capítulo con contenido tiene introducción y conclusiones.

63) En ocasiones hay que describir muchas situaciones relevantes pero equivalentes. Esto puede ocurrir por ejemplo al describir una simulación. Es interesante en ese caso hacer una hoja patrón (similar a las que se utilizan en las ISO9000) que se rellena para cada situación. De este modo no se tiene la impresión de estar escribiendo lo mismo. (No se tiene la impresión porque se sabe).

A.6 Finalizar

64) Corrige cuando ya hayas escrito lo que tenías que escribir. Pero ante todo corrige.

65) Para corregir el documento un buen truco es empezar unas veces por el medio y otras por el final. De este modo evitas lo habitual: que las tres primeras hojas hayan sido revisadas muchas veces y las demás ninguna.

66) Otro buen truco es leer en voz alta, con entonación adecuada, el texto escrito. En realidad no se tarda más de dos horas en leer un proyecto que esté correctamente escrito.

67) Si has seguido el punto 41 puedes ir imprimiendo los capítulos a medida que los revisas, y de este modo tener sensación de trabajo finalizado. Aunque si hay que hacer correcciones se hacen.

68) El capítulo de introducción explica qué quieres hacer, por qué es importante y cuál es la estructura con la que vas a desarrollarlo.

69) El capítulo de conclusiones explica qué has hecho, para qué lo has hecho, qué dificultades has superado y qué queda por hacer.

70) El capítulo de conclusiones es lo penúltimo que se debe acabar.

71) El capítulo de introducción es lo último que se debe acabar.

A.7 La revisión

72) Aunque es bueno ir comprobando a medida que escribes que lo que haces es razonable no te obsesiones. En realidad revisar no exige el mismo esfuerzo que escribir. Por eso tendemos a revisar en lugar de a escribir, porque es más cómodo.

73) Revisa los capítulos de manera independiente. Imprímelos como si fueran el resultado final.

74) De vez en cuando lee cambiando el orden de los párrafos (por ejemplo del final al principio).

75) Si pretendes que tu revisor haga su trabajo no le envíes un documento por la noche de un jueves diciéndole que necesitarías la revisión antes del fin de semana para poder seguir trabajando. Eso molesta mucho al revisor.