Cómo escribir un proyecto

En la mayoría de las universidades, el llevar a cabo proyecto es una asignación obligatoria e independiente de la elaboración de la tesis. Al respecto, si desea obtener una buena nota para su proyecto, es absolutamente esencial que escriba un buen informe. Es el informe el que se califica, no son los resultados ni ninguna otra cosa que hayas construido durante el periodo del proyecto. Por muy importantes que sean tus logros, si no redactas bien tu trabajo, obtendrá una mala calificación.

La Mecánica de la Escritura de un Proyecto

El problema que tienes que resolver es el siguiente: trasladar de tu cerebro al papel tus propias experiencias al realizar el proyecto y los conocimientos que has adquirido, de forma coherente, lógica y correcta.

Hay varias formas de conseguirlo. Cada autor tiene una técnica diferente. Un método popular, consiste en escribir tan rápido como puedo, sin tener en cuenta la coherencia, la estructura o el orden, hasta que hayas escrito (o mejor dicho, tecleado) todos los puntos que se te ocurran. Si su cerebro va más rápido que tus dedos y se le viene a la cabeza una idea que pertenece a otra parte del documento, salte al final de la página e inserte allí unas palabras para recordar que debe ampliar ese punto más tarde, y luego continúa donde estaba. El objetivo es transferir la mayor cantidad de material relevante del cerebro al papel lo más rápidamente posible. Este método se ha denominado «brain dump». Lo practican, algunos escritores de ficción, así como autores técnicos (Docherty, 1999).

Precisión

En primer lugar, hay que esforzarse por ser absolutamente preciso. Cuando escribes, no es suficiente que sepas lo que quieres decir; tampoco es suficiente que tu escrito admita el significado que pretendes: no debe admitir ningún otro significado. Lo que escribas no debe ser susceptible de ser malinterpretado. Tenga un cuidado excepcional en la elección de la palabra adecuada para la ocasión. No escribas, por ejemplo, «óptimo» si quieres decir «bueno». «Aproximado» significa «cercano», por lo que «muy aproximado» significa «muy cercano», que no es lo que mucha gente parece creer que significa.

Vigor

La precisión en la escritura es sobre todo una cuestión de cuidado. Sin embargo, la buena escritura no sólo es precisa, sino también vigorosa, y eso es mucho más difícil de conseguir. Ayuda el haber leído mucho, sobre todo novelas. He aquí algunos consejos que pueden ayudarle a escribir con fuerza y vigor.

Prefiera las frases cortas a las largas y las palabras cortas a las largas, siempre que la palabra corta tenga el significado que usted necesita. La brevedad es una gran virtud en la escritura técnica. (Pero no vaya demasiado lejos; recuerde la observación de Horacio: «Brevis esse laboro, obscurus fio»). Evite los circunloquios. «En casi todos los sectores del mercado informático» puede sustituirse en la mayoría de los contextos por «en casi todas partes».

Voz Pasiva

La cuestión de si se debe utilizar la voz pasiva en la escritura técnica es complicada. La mayoría de los escritores más veteranos siguen escribiendo «se escribió un programa…» en lugar de «escribí un programa…». Puede que muchos de sus examinadores compartan esta preferencia o prejuicio a favor de la voz pasiva, pero este estilo está casi en desuso en toda la escritura técnica, y te aconsejo que no lo uses. Haga lo que haga, no utilice el «nosotros» real («escribimos un programa» cuando quiere decir «yo escribí un programa»).

Existe un consenso generalizado sobre la conveniencia de evitar las frases en latín en la escritura técnica (aunque la cita ocasional en latín puede dar un falso aire de erudición). La mejor regla es que una frase en latín es aceptable si abrevia una frase circunlocutiva en inglés. Mutatis mutandis, por ejemplo, una de mis favoritas, es permisible en lugar de «hacer los cambios apropiados», ya que cualquier glosa en inglés parece fea y poco manejable. «I.e.» (nótese el tipo de letra romana y la puntuación) suele ser útil en lugar de «en otras palabras» o «es decir», y es ampliamente entendido. Sin embargo, a menudo «X, es decir, Y» puede sustituirse por «Y», porque el escritor se dio cuenta mientras escribía X de que Y decía lo mismo, sólo que mejor. «Ej.» está sobreutilizado y es mejor usarlo con moderación; prefiera «por ejemplo».

Ortografía y Gramática

Debe poner un cuidado excepcional en la ortografía. La mala ortografía es una distracción para el lector experto. En la mayoría de los casos, los errores ortográficos no tienen excusa; hay muchos programas excelentes de corrección ortográfica que se encargan de encontrar los errores por ti, y excelentes diccionarios (en papel) que te dirán cuál es la ortografía correcta. Tenga especial cuidado con las palabras cuyo error ortográfico más común es una ortografía correcta de una palabra diferente. Es peligroso dejar que el corrector ortográfico «corrija» por sí mismo un error ortográfico; se han registrado muchas «correcciones» de este tipo, por ejemplo, recientemente en New Scientist.

Tipografía

El mejor y más famoso libro de referencia tipográfica es Rules for compositors and readers at the University Press, Oxford, de Horace Hart, conocido coloquialmente y universalmente como «Hart’s Rules». Es un libro pequeño que probablemente debería leer de principio a fin, pero puede saltarse la sección sobre ortografía rusa si su informe no contiene palabras en ruso. Este libro, al igual que el de Fowler, ha sido revisado continuamente desde su primera publicación. La última edición data de 1983. Sigue imprimiéndose, casi un siglo después de su primera publicación, merece la pena comprarlo.

Ilustraciones

Por lo general, el informe debe contener ilustraciones (figuras o diagramas), pero deben ser pertinentes. Pregúntate si la ilustración ayuda al lector a entender el texto. Si el texto es fácilmente comprensible sin la ilustración, elimínela. Si no lo es, suele ser mejor aclarar el texto que añadir un diagrama.

Todas las ilustraciones deben prepararse con un programa adecuado, como pic, xfig o grap. No deben ser dibujadas a mano. La única excepción a esta regla son los diagramas de circuitos: dado el estado actual de los paquetes de introducción de esquemas, un diagrama de circuitos dibujado a mano suele ser preferible a uno dibujado por ordenador.

Si es posible, incluya las figuras cerca del texto que hace referencia a ellas, en lugar de incluirlas todas juntas en un apéndice. Los esquemas de los circuitos son, de nuevo, una posible excepción a esta regla. Lo normal es enumerar las tablas y figuras al principio del informe, después del índice.

Estructura del Proyecto

Estructura de Nivel Superior

En el nivel superior, un informe típico se organiza de la siguiente manera.

Resumen

Se trata de un par de párrafos -no más- que resumen el contenido del informe. Debe ser comprensible para alguien que no haya leído el resto del informe.

Introducción

El alcance del proyecto, estableciendo el escenario para el resto del informe.

Trabajos anteriores

Uno o varios capítulos de revisión, en los que se describa la investigación que realizaste al principio del periodo del proyecto.

Varios capítulos que describan lo que has hecho, centrándose en los aspectos novedosos de tu propio trabajo.

Trabajo posterior

Un capítulo en el que describa las posibles formas de continuar o desarrollar su trabajo. Sé imaginativo pero realista.

Conclusiones

Es similar al resumen. La diferencia es que aquí debe suponer que el lector de las conclusiones ha leído el resto del informe.

Referencias

Las referencias deben ser pertinentes. Un informe típico de un proyecto PR3 puede contener alrededor de una página de referencias pertinentes, si el periodo de investigación inicial fue bien aprovechado. No incluya referencias que no haya leído, por muy relevantes que le parezcan. Si te refieres a material estándar que está cubierto por un gran número de libros de texto, elige uno o dos realmente buenos y cítalos, en lugar de una larga lista de textos mediocres.

Hay muchos estilos para citar referencias. Aunque existen normas estrictas (por ejemplo, las normas británicas) para citar referencias, mi consejo es que no te preocupes por ellas; en su lugar, busca una revista de renombre en la biblioteca y copia su estilo. O bien, copie el ejemplo que aparece a continuación. Es importante ser coherente, completo y sin ambigüedades; más allá de eso, no importa mucho lo que haga (Frankel, 2001).

Ejemplo de estilo de citación

Citas en el texto:

Mander, en «Notas sobre un método de especificación de sistemas» [Mander 1983], da lo siguiente …

… como lo describe Briggs [1983a] …

Las directrices de Thimbleby [Thimbleby 1983] sugieren que …

Se han examinado diferentes metodologías [Tully 1983].

Varias publicaciones recientes en este campo [Wand 1980d, ACM 1971] han sido muy influyentes.

Lista de referencias al final del informe:

ACM 1971.Association for Computing Machinery, Second symposium on problems in the optimisation of data communication systems, ACM (1971).

Briggs 1983a.      J.S. Briggs, «The design of AIR and its use in Ada separate compilation», en SERC workshop on Ada software tools interfaces, ed. P.J. Wallis, University of California. P.J. Wallis, Universidad de Bath (1983).

Si adopta este estilo, cuando cite una referencia, no es necesario que repita el nombre del autor o los nombres de los autores («Jones y Sanderson [Jones y Sanderson 1999] han demostrado…»). Escriba en su lugar «Jones y Sanderson [1999] han demostrado…», y cite la referencia como «Jones y Sanderson 1999».

También es aceptable un sistema de referencias numeradas, como el formato por defecto producido por la herramienta Unix refer en conjunción con troff. Yo mismo prefiero los estilos de citación numerados, que me parecen mucho menos molestos y más fáciles de ver; por ejemplo, «Jones y Sanderson¹ han demostrado…» o «Jones y Sanderson [1] han demostrado…». Estas formas, permitidas por las normas del Manual, parecen ser los dos estilos de citación dominantes en las revistas académicas.

Es posible que desee hacer referencia a fuentes electrónicas, en particular al material encontrado en la World-Wide Web. No basta con poner «encontrado en la WWW» en lugar de una cita. La página web «Bibliographic Formats for Citing Electronic Information» ofrece consejos para citar fuentes en línea.

En la medida de lo posible, evite citar bibliografía no publicada. Sin embargo, es aceptable citar informes universitarios y tesis doctorales.

Las «referencias» se citan siempre en el texto. Otras obras a las que haya recurrido pero que no se hayan citado deben figurar en una sección llamada «Bibliografía».

Tenga en cuenta que «et al.» requiere un punto después de la abreviatura «al.» (por «alia»). Significa «y otros», y sólo puede utilizarse para referirse a personas, normalmente en listas de referencias. Es la forma animada de «etc.», que también requiere un punto.

Estructura de Nivel Inferior

La estructura es un concepto recursivo. Un informe bien estructurado tiene sus secciones de nivel superior bien ordenadas, y es fácil hacerlo bien; pero cada sección debe estar en sí misma bien ordenada, y eso es más difícil.

La mayoría de los documentos en papel, y muchos documentos en línea, se leen linealmente de principio a fin. Esto es ciertamente cierto para un examinador que lee un informe de proyecto. Por lo tanto, el redactor de un documento bien estructurado evita las referencias hacia adelante siempre que sea posible. Intente evitar escribir «… como veremos en el capítulo 10, …», especialmente si el material del capítulo 10 es esencial para la comprensión del texto en el punto en el que se produce la referencia. En ocasiones, estas referencias son inevitables, pero la mayoría de las veces son una señal de que hay que reordenar el texto.

Antiguamente, para reordenar el texto había que «cortar y pegar» con tijeras y pasta de verdad. Hoy en día, el procesador de textos ha facilitado tanto estas operaciones que no hay excusa para una estructura descuidada. Tómate tu tiempo y sigue reordenando palabras o frases dentro de las oraciones, oraciones dentro de los párrafos, párrafos dentro de las secciones y secciones dentro de todo el informe hasta que lo consigas. Intenta conseguir una progresión lógica desde el principio hasta el final, con cada frase basada en las anteriores.

Si los capítulos se numeran 1, 2, 3, …, las secciones del capítulo 1 se numerarán 1.1, 1.2, … . Está permitido subdividir una sección: las subsecciones dentro de la sección 1.1 se numerarán 1.1.1, 1.1.2, … . Sin embargo, no anide las subsecciones a más de cuatro niveles: la subsección 1.2.3.4 es aceptable, pero la 1.2.3.4.5 no lo es. Es muy posible, con cuidado, escribir incluso un libro grande y complejo sin utilizar más de tres niveles.

Las notas a pie de página son una molestia para el lector. Interrumpen el flujo lineal del texto y exigen un esfuerzo mental de apilamiento y repliegue que requiere un esfuerzo consciente. Hay raras ocasiones en las que las notas a pie de página son aceptables, pero son tan raras que es mejor evitarlas por completo. Para eliminar una nota a pie de página, intente primero ponerla en línea, rodeada de paréntesis. Es probable que la mala estructura que disimulaba el aparato de la nota al pie se haga evidente y pueda mejorarse cortando y pegando.

Nuestros especialistas esperan por ti para que los contactes a través del formulario de cotización o del chat directo. También contamos con canales de comunicación confidenciales como WhatsApp y Messenger. Y si quieres estar al tanto de nuestros novedosos servicios y las diferentes ventajas de contratarnos, síguenos en Facebook, Instagram o Twitter.

Si este artículo fue de tu agrado, no olvides compartirlo por tus redes sociales.

Referencias Bibliográficas

KJ, Frankel RM. Getting qualitative research published. Educ Health 2001; 14: 109–117.

Docherty M, Smith R. The case for structuring the discussion of scientific papers. Br Med J 1999; 318: 1224–1225.

International Journal for Quality in Health Care vol. 16 no. 3 © International Society for Quality in Health Care and Oxford University Press 2004; all rights reserved