El proceso y arte
de escribir incluye secretos, recomendaciones y guías
Un
documento escrito par ser usado por los participantes del Programa IIIEE
Masters
Compilado
por Joseph Strahl, Septiembre,
1997
Introducción
Algunas recomendaciones generales
Dando inicio
Estructurando el documento: un primer vistazo
Planificando su tiempo
Escribiendo el paper
Revisión de la estructura: lo que todos los
documentos deberían tener
La apariencia de
un documento y las mecánicas para la escritura
Credibilidad y
validez de las fuentes
Notas al pie de página,
citas, referencias y fuentes
Presentación
de la tesis: reglas y recomendaciones
Sumario
Mientras participe del IIIEE, usted escribirá muchos documentos, memos, reportes y una tesis. El propósito de este documento es el de ayudarlo en su empeño en escribir mejores documentos. Nos concentraremos en los errores que ocurren en el proceso anterior al de escribir sus primeras oraciones; en cómo deberían organizarse los documentos; en la relación comunicativa que existe entre el autor y el lector; la importancia del cuestionamiento de las fuentes; y las mecánicas del listado de referencias a las fuentes. No consideraremos errores gramaticales.
Reconocimientos
Este documento no fue escrito solamente por una persona. El original fue iniciado en 1994 por Helena Jörnlid, Thomas Lindqvist y Joseph Strahl. Otras partes fueron bosquejadas durante el otoño de 1995 por Curt Görman y Peter Kisch. Durante el verano de 1996, Joseph Strahl sintetizó todas las partes. La versión que usted está leyendo en este momento fue completada en septiembre de 1997, y algunas partes fueron modificadas significativamente; además, Karin Ohrt contribuyó con material adicional. Cualquier documento escrito sobre cómo escribir documentos está, por si mismo, sujeto a mejoras continuas.
La organización de este documento
Este documento ha sido organizado en un orden más o menos cronológico de los eventos que están conectados al proceso de la escritura de documentos o tesis.
Algunas
recomendaciones generales
Existe un punto de inicio común para cualquier tipo de escritura. La escritura es un proceso de conceptualización de un mensaje en una forma preliminar, para que posteriormente se exprese y explique a un lector, en forma escrita, sus ideas, pensamientos, puntos de vista, hallazgos, resultados, conclusiones, etc. La música y el arte también se inician con la conceptualización de un mensaje, con la diferencia que esta conceptualización da como resultado sonidos e imágenes, y no palabras. El objetivo último de su escritura, sea cual fuese el tipo de esta, es el de transferir su mensaje en forma escrita y tan efectivamente como pueda a su receptor. Una buena escritura debe dejar una firme impresión en la mente del lector. Puede que usted nunca gane un premio de literatura por sus esfuerzos, pero su escritura puede ser inspiradora e interesante.
¿Cuál es el propósito de su escritura?
El propósito de su escritura es bastante obvio. El proceso de la escritura siempre debe comenzar con la consideración del propósito; sin embargo, muy a menudo nos saltamos este paso y nuestra escritura sufre las consecuencias, lo que puede ocasionar que nos veamos forzados a reescribir el documento con mayor frecuencia. Por lo tanto, es importante que empiece su trabajo formulándose muchas preguntas, como las que se listan a continuación:
Cuando se escribe un documento, el punto obvio de inicio es la elección de un tema. Ya sea que usted mismo lo escogió o que se lo asignaron, es muy importante que antes que nada quede muy claro para usted (y para la persona que sea su guía) qué es lo que quiere lograr con la escritura del documento y por qué. Una visión más clara de sus objetivos y del tema se irá desarrollando a medida que avanza en el trabajo. Cuando empiece a escribir, es importante que tenga siempre en mente sus objetivos y que su conceptualización sea precisa y esté bien limitada.
Una palabra acerca de la objetividad
La escritura académica debe ser siempre muy objetiva. Esto significa que debe tender a ocultar al autor detrás de frases que den la impresión de haberse escrito a sí mismas. Así, queda estrictamente prohibido el uso de las palabras yo y nosostros . Pese a que puede ser que nosotros hayamos sido entrenados para escribir de esta forma y haber aprendido que la objetividad y la distancia hacia nuestro trabajo son importantes, este estilo puede sacrificar la claridad en desmedro de la objetividad. Si un documento es claro y fácil de leer, un lector alerta encontrará fácilmente los lugares en los que el autor no fue objetivo. De hecho, por el interés de la claridad uno puede sólo recomendar autores que se atreven a anunciar a sus lectores cuáles son sus verdaderas opiniones.
La preparación facilita la lectura y la escritura
Un error muy común es subestimar el tiempo que se necesita para preparar el documento final. Preparar la escritura y después escribir el documento puede tomar más tiempo del que esperaba o pretendía. Si se toma un tiempo para preparar y estructurar su documento antes de empezar a escribirlo, dará como resultado un documento bien escrito y con mucho menos esfuerzo. Un documento bien estructurado es, además, más fácil de leer y de entender. La palabra estructurado debe entenderse como la decisión que se tiene que tomar acerca de cómo ordenar jerárquicamente los temas que se tocarán a lo largo del trabajo. Esta estructuración también dará como resultado una cierta cantidad de temas a los que se hará referencia dentro de esta jerarquía, lo que terminará conformando el bosquejo del texto.
Así, con sólo leer este bosquejo, se puede tener una buena idea acerca de lo que trata el documento. Los títulos o subtítulos reflejan tanto el contenido como la jerarquía de los diferentes temas que se discuten en su trabajo, dicho en otras palabras:
Los
títulos y subtítulos proveen la estructura e invitan al lector
El
texto provee el contexto
Ya
que nunca se tiene el tiempo ni las posibilidades de escribir en su documento
acerca de todo lo leído, debe delimitar claramente los alcances
de su trabajo, es decir, establecer límites para lo que será
u no será incluído en su documento. Las limitaciones son
una consecuencia muy natural de la determinación del objetivo de
su escritura.
Búsqueda de la literatura y planteamiento del problema
Una vez escogido el tema, debe empezar a investigar la literatura disponible acerca de éste, de tal forma que pueda obtener una visión más clara sobre los problemas concernientes al mismo. Leyendo uno o varios documentos generales, obtendrá algunas ideas para determinar dónde investigar con mayor profundidad, y además logrará un conocimiento más amplio que podrá ser relacionado con su propia investigación. A medida que vaya leyendo, piense en los temas a los que puede referirse en su documento. Un buen comienzo es realizar notas de algunos pasajes sobre los que tenga dudas o críticas. Pero recuerde que debe limitar la literatura que va a estudiar. Una buena práctica para determinar si el libro será de alguna utilidad, es leer su introducción y sus conclusiones.
Los temas de muchos trabajos no se han basado necesariamente en fuentes literarias, sino en entrevistas o alguna otra forma de estudios. Cuando llegue el momento de empezar a escribir su tesis, su profesor guía o algunas otras personas de la institución en la que realiza sus estudios, pueden darle algunas pautas sobre las personas que estén relacionadas con su tema o la literatura que debe consultar, de tal forma que pueda obtener una idea general de su área de investigación.
Para poder proceder de la idea general de su tema y la literatura hacia su propia investigación particular y el material que vaya a usar, es necesario que se plantee el problema tan clara y concisamente como sea posible. El tipo de material más adecuado como punto inicial de su trabajo depende enteramente del problema a ser investigado. Una formulación clara del problema es necesaria para poder determinar en qué forma y con qué material trabajará mejor durante su investigación.
Por lo tanto, tan pronto como sea posible, usted debe enmarcar el tema de su investigación a través de la formulación de preguntas que quisiera sean respondidas y también, si es posible, preguntas suplementarias sobre las que no se expandirá demasiado. ¿Qué es lo que será investigado y descrito? ¿Qué conceptos son centrales para la formulación del problema? Se dice que la oración que establece el objetivo del documento es la más importante de todo el trabajo. El hecho que esta oración sea vaga, no muy clara, afectará a todo el trabajo.
Material y fuentes
Una vez que haya obtenido toda la información necesaria y que su tema sea tan cristalino, al punto de haber formulado el problema y las preguntas, entonces es tiempo de determinar cuál es el material apropiado para usar durante la investigación. Puede ser que usted necesite ayuda de su profesor guía. Una regla importante es limitar el material sustancialmente. Es más importante poder realizar un trabajo profundo con poco material y hacer observaciones independientes que utilizar mucho material y hacer un trabajo superficial. Al no utilizar demasiado material, se aumentan las posibilidades de pensar realmente acerca de lo que se está leyendo y poder así obtener las conclusiones adecuadas de esta lectura. Si alcanza el tiempo, es mejor complementar algunos aspectos posteriormente con otro material y comparaciones, que romperse la cabeza desde el principio.
El material puede, incluso debe, ser de diferente naturaleza. Aquí se debe hacer una distinción muy importante entre fuente y literatura. Una fuente es la mención y la posible incorporación futura de una descripción científica reconocida en su área de investigación dentro de su trabajo; mientras que literatura es una documentación general acerca de lo que otros han escrito sobre su área, es decir, son otras investigaciones ya realizadas. Esta literatura se constituye en material que puede utilizarse como evidencia que apoya su propuesta, o puede analizarse el razonamiento y las conclusiones que encuentra en ella.
También debe hacerse una distinción entre datos primarios y fuentes secundarias. Un anuario estadístico de una agencia de gobierno contiene datos primarios. En cambio, un libro cuyo autor está comparando el estándar de vida en diferentes países del continente a través del tiempo, puede contener referencias a datos primarios. Mientras sea posible, debe usar fuentes primarias, y no tablas, por ejemplo, extractadas de fuentes secundarias.
Estructurando
el documento: un primer vistazo
En esta guía para escribir un documento, consideraremos dos estructuras principales o modelos que pueden ser usados para organizar un documento: el llamado modelo lógico-histórico y el popular modelo científico/periodístico. El primero se refiere esencialmente a la forma en que son estructurados muchas tesis y trabajos similares, así como muchos artículos que aparecen en periódicos o revistas científicas. Ambas formas de estructurar un documento tienen sus méritos, similitudes y usos, y el uso de una no debería significar la exclusión de la otra. Aún más, es posible combinar ambas formas y todavía producir buenos resultados.
Generalmente, quisiéramos abogar por un uso más frecuente del modelo científico/periodístico. En este modelo los mensajes más importantes aparecen primero. Puede ser que los lectores que tengan poco tiempo disponible sólo lleguen a leer dos o tres páginas de un documento de quince. Por eso, un autor que escriba sus mensajes más importantes recién en la página doce, sólo logrará perder al autor en el proceso de lectura.
Las figuras 1 y 2 deberían dar una mejor idea de por qué abogamos por un uso más frecuente de la estructura de ciencia popular.
Figura 1: El método lógico-histórico
Posición
en el documento, de principio a fin
Figura 2: El método popular científico/periodístico
Posición
en el documento, de principio a fin
En cierta forma, el modelo lógico-histórico es como una larga broma contada en un cocktail: para cuando se llega a la parte más cómica, ya nadie está escuchando. Por otro lado, el modelo científico atrapa su atención, da el mensaje más importante en la primera parte del documento, y después refuerza el principio con evidencia de apoyo, haciendo referencia a otros estudios importantes y a observaciones menores.
El método lógico-histórico refleja, en diferentes grados, el orden cronológico real de los eventos que se llevaron a cabo en cierto punto del tiempo. El autor estructura su documento alrededor de la cronología. Sin embargo, en la actualidad, rara vez el proceso investigativo es tan prolijo y ordenado. La experimentación es llevada a cabo metodológicamente con comienzos falsos y fines muertos, pero esto generalmente es quitado del informe final.
Pese a que un artículo escrito utilizando el método popular científico puede ser al principio corto de contexto, para cuando el lector termina de leerlo ya ha recibido toda la información necesaria. El riesgo se presenta cuando muchos lectores quedan satisfechos con leer la parte ¿Qué es nuevo? del documento y se basan en esto el momento de escribir sus propios documentos. El lector no le hace ningún favor al autor del documento original, ni se lo hace a sí mismo, si no lo lee completamente antes de empezar a utilizarlo como una fuente. Otro argumento para no utilizar el método popular científico es que al principio, en su forma más extrema, al lector solamente se le da información fragmentada.
Es posible asumir un compromiso entre los dos modelos: en cierta forma un buen abstracto funciona como un sustituto de un documento estructurado con el método popular científico. El lector comprende rápidamente la sustancia del documento cuando el abstracto está bien escrito. Sin embargo, un informe de diez páginas escrito sin la intención de ser publicado, rara vez tiene un abstracto.
Un mejor acuerdo aún, en el que el autor escoge usar el modelo lógico-histórico pero quiere darle al lector un buen comienzo, consiste en escribir un resumen corto al principio del documento, presentando los mensajes más importantes. Si su documento tiene alrededor de cincuenta páginas, sería una buena práctica resumir todos los hallazgos y las conclusiones más importantes del documento en las primeras dos o tres páginas; esto significa que se comienza utilizando el modelo popular científico y luego se cambia inmediatamente al modelo lógico-histórico. Este resumen inicial es conocido también con el nombre de Resumen Ejecutivo. Muchas tesis usan esta estrategia.
Ya
que muchos de nosotros rara vez escribimos tesis o columnas de periódicos,
nuestra escritura puede caer muy frecuentemente entre los dos tipos de
estructuras puras. Pese a que la ciencia popular y el periodismo nos pueden
parecer negativos a algunos de nosotros, no hay una ley que prohiba la
utilización de ésta para estructurar un documento académico.
Aún a pesar de que la organización parte de la que comúnmente
se utiliza en una tesis, el autor debe tener cuidado en seguir las reglas
apropiadas de referenciación y debe además cuestionarse la
validez y credibilidad de las fuentes. Volveremos a este punto más
adelante.
Ya al principio del documento, usted debería escribir una presentación corta de su trabajo (una página A4), que puede funcionar como su punto de partida (y posiblemente el de su profesor guía, cuando lo encuentre). Usted puede recibir ayuda y algunos puntos de vista sólo si ha presentado lo que está haciendo y ha descrito los problemas encontrados en forma clara y concisa. Recuerde que cuando escribe un resumen breve, está forzado a pensar a través de sus objetivos. Este breve resumen debe contener:
1.
Tema y objetivo
2.
Planteamiento del problema y preguntas
3.
Proposiciones para la disposición
4.
Información acerca del material escogido
5.
Presentación del método y del problema
6.
Información acerca de la literatura encontrada
Es importante empezar a escribir el documento cuando aún se cuenta con un buen margen de tiempo. No asuma que la mera escritura progresará rápidamente, ni siquiera si usted cree que tiene una visión clara del contenido.
Frecuentemente es de mucha ayuda discutir el documento con otra persona, y de ese modo recibir comentarios sobre lo que todavía necesita definirse más claramente, o recibir ideas acerca de cómo debe presentarse el material. Siempre planifique contar con un tiempo de reserva al final del proyecto, y recuerde que el trabajo técnico (tal como la transcripción del documento, etc.) que se realiza en la fase final, también toma tiempo.
Ahora usted ya ha llegado al punto central de su trabajo, en el que progresivamente ordena su material, lo sistematiza y, poco a poco, enlaza la información obtenida, sus interpretaciones y las conclusiones, de tal forma que el futuro lector pueda entender lo que ha hecho y aprenda algo sobre la materia. Uno nunca puede haber terminado una porción de la escritura, mientras no haya terminado el documento completo. Por lo tanto, es muy importante que empiece a escribir su primer borrador tan pronto como le sea posible. De esta forma estará a tiempo de tomar en cuenta las sugerencias posteriores que le puedan dar sus colegas o guías.
Los seis pasos siguientes fueron escritos con la idea de ayudar a los estudiantes a estructurar un documento tradicional con una organización lógico-histórica. De todas formas, muchos de los puntos son igualmente relevantes para la escritura de cualquier otro tipo de documento. Hemos intentado comentar las diferencias existentes entre los modelos popular científico y lógico-histórico en cada uno de estos puntos.
2. Sustentación (referenciación de fuentes). Cada afirmación, cada oración hecha en el documento, que no sea generalmente conocida y aceptada, debe ser sustentada. Esto se logra haciendo referencia a la fuente de información de tal forma que pueda ser fácilmente verificada. Es importante que usted esté enterado de cuál es la fuente que se está utilizando y del valor de esa fuente y/o de la información que posee. Cuando usted cita directamente una fuente, estas citas deben ser escritas entre comillas.
3. Evaluación de la fuente. Esto significa que uno no acepta la información contenida en las fuentes, sin evaluarlas previamente. La credibilidad de aquello que está siendo afirmado debe estar abierta a cuestionamiento. En general, esto se aplica a cualquier cuestión referente a la credibilidad de la fuente, especialmente si se sospecha que ésta está siendo inclinada en una dirección que podría afectar el valor de esa información en particular. Algunas preguntas buenas para evaluar el material fuente son: ¿Cómo obtuvo la información? ¿Por qué esta fuente recuenta la información? ¿Quién obtiene algún beneficio de la diseminación de la información? ¿Algo ha sido omitido o descuidado? Más que los ingenieros, los humanistas y científicos sociales generalmente tienen gran experiencia en meditar sobre la credibilidad de las fuentes y exhibir preocupación por la validez de información no numérica en particular. Por esta razón, los científicos naturales, ingenieros y otras personas no acostumbradas a cuestionar la credibilidad de la fuente, deberían realizar un esfuerzo extra y no temer ser críticos de sus fuentes.
4. Interpretación. Es importante diferenciar entre la presentación de un hecho y la interpretación del mismo. También se debe diferenciar entre la interpretación de una fuente de información, la interpretación de otros investigadores y la interpretación propia. Esta distinción debe ser indicada claramente en el documento, y, si es posible, uno debe intentar explicar estas diferencias en la interpretación. El valor de las conclusiones dependen en gran medida de la interpretación de la variedad de información que está siendo relacionada con las preguntas y el propósito del documento.
5. Análisis y síntesis. El análisis y la síntesis son pasos centrales en un trabajo científico y deben mantenerse claramente separados. Es especialmente importante no anticipar la síntesis en el análisis. El análisis es el proceso de extractar del material respuestas a preguntas formuladas, evaluando e interpretando estas respuestas, así como sustentando su propia interpretación en cada uno de los puntos. La síntesis consiste en sacar conclusiones de los diferentes análisis realizados, y si es posible, resumir las conclusiones en una solución para el problema escogido. En el método de ciencia popular para la estructuración de un documento la síntesis puede aparecer antes de varios análisis individuales, y aún así la síntesis y el análisis deben permanecer claramente separados. En un documento muy corto o uno que no se pretende distribuir, la distinción entre la síntesis y el análisis puede no estar muy claramente expresada o su importancia puede ser mucho menor que en un documento estrictamente científico.
6. Resumiendo la cadena de eventos realizados para la estructuración de un documento: Las fuentes ofrecen el material, el material es interpretado, las interpretaciones son analizadas, del análisis se sacan conclusiones, las conclusiones son resumidas en una síntesis que describe la conclusión final a la que arribó el autor del documento. Nuevamente, el orden de la presentación de un documento más periodístico será, más o menos, el inverso de la cadena de eventos listada acá.
Un documento debería tener un título. Si es un documento largo, debería tener una carátula con el título, el nombre del autor, el nombre de la institución para quien se escribió el documento y, tal vez, incluso una figura relevante. El título debe reflejar el contenido del documento y picar el interés del lector. Los títulos no deben ser engañosos. Generalmente son preferibles los títulos cortos, pero esto no siempre es posible lograr.
Si su documento contiene solamente alrededor de cinco páginas, es decir, es más como un memo o un reporte breve preparado para la persona con cargo superior al suyo dentro de su oficina, no hay necesidad de tener una tabla de contenido. En cambio, un documento de más de veinte páginas definitivamente debe tener una tabla de contenido.
Todos los documentos deben tener un resumen (un documento de dos páginas puede ser una excepción). Dependiendo del tema y de la audiencia objetivo, el resumen aparecerá al principio o al final. Un resumen debe dar una buena idea de todo el contenido del documento, de tal forma que quien toma decisiones quede satisfecho con la lectura de sólo dos páginas en vez de veinte. Un buen resumen contiene la esencia de las ideas y argumentos del documento entero, pero no cuenta la historia completa.
Entonces, el cuerpo principal del documento debe presentar argumentos, ideas y mensajes en forma agradable y lógicamente consistente. El documento puede reportar los resultados de un proceso de producción cambiado; puede discutir los cambios en las políticas de una compañía, de tal forma que la credibilidad medio ambiental del producto o sitio sea aumentada; puede comparar la legislación del medio ambiente en diferentes países. Este último documento podría incluir una sección de metodología (¿Cómo se compara una legislación?), mientras que los dos primeros probablemente tengan menos razones para discutir un tópico como este.
Dependiendo
del tipo de documento, puede haber la necesidad de incluir una sección
de conclusiones y recomendaciones. Esto no es lo mismo que el resumen,
ya que un resumen debe incluir material de la introducción, del
cuerpo principal y las conclusiones.
Carátula.
Además del título, esta página también debe
contener información acerca de la institución o el nombre
y área del departamento para el que el informe está siendo
elaborado, la fecha de presentación del documento, el nombre del
supervisor y el nombre del autor.
Posiblemente, debería haber un prefacio que siga a la carátula. Especialmente cuando se trata de documentos largos el prefacio sirve para dar pautas acerca del entorno en el que se realizó el trabajo, agradecimientos a las personas que contribuyeron en su realización al dar consejos y puntos de vista, e incluso reflexiones personales. Cuando el documento es corto, muy rara vez necesitan de un prefacio.
Tabla de Contenido. Existen diferentes opiniones acerca de cuán detalladamente deben listarse los subtítulos en una Tabla de Contenido. Algunas personas piensan que la Tabla de Contenido debe tener los títulos y subtítulos hasta el cuarto nivel (por ejemplo, Capítulo 3, Sección 2, Sub-sección 3, Título2). Si bien este método es inclusivo, el lector debe preguntarse de cuánta ayuda puede ser este grado de detalle en una Tabla de Contenido. En este ejemplo, la claridad está siendo sacrificada en desmedro del detalle. En una tesis de maestría de alrededor de 100 (cien) páginas uno debe preguntarse si se justifica que la Tabla de Contenido ocupe cuatro. ¿Quizás una Tabla de Contenido de sólo dos páginas sería suficiente?
Un posible resumen. Si el documento es largo, es una buena idea resumir las secciones más importantes antes de comenzar a escribir el cuerpo principal de éste. Si usted quiere una inspección y curso de lo que ha escrito, entonces, un documento corto debería empezar con un resumen también corto.
Introducción. Debería contener:
Cuerpo Principal. Acá se presenta la investigación completa, dividida en un cierto número de secciones, según sea apropiado. Los siguientes puntos deberían incluirse:
Conclusiones. Esta sección debe ser corta e incluir:
Tabla de Contenido. Ver los comentarios y explicaciones del cuadro anterior.
Conclusiones y Consecuencias. Esta sección puede incluir:
Métodos y Fuentes. Esta es una mezcla del material que aparece en el Cuerpo Principal y en la Introducción de un trabajo realizado con el modelo lógico-histórico, y puede incluir:
Las
notas al pie de página son referencias a las fuentes de información.
Comúnmente, al final de cualquier documento o reporte, aparece un
listado de todas las fuentes de información. Este listado es conocido
con el nombre de Bibliografía, en el caso de que todas las fuentes
de información sean documentos escritos. En otro caso el título
Fuentes es más apropiado. Los tecnicismos referentes a las notas
al pie de página y el listado de fuentes se tratarán más
adelante.