Escolar Documentos
Profissional Documentos
Cultura Documentos
Indice general
1. Introduccin o 2. Cmo escribir la Introduccin o o 3. Cmo organizar el cuerpo del informe o 4. Cmo escribir las Conclusiones o 5. Aspectos complementarios 5.1. La bibliograf y las referencias . . . . . . . . . . . . . . . . . . . . . . . . . a 5.2. Inclusin de guras y tablas . . . . . . . . . . . . . . . . . . . . . . . . . . . o 5.3. Edicin del documento . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . o 5.4. Recomendaciones Generales . . . . . . . . . . . . . . . . . . . . . . . . . . . Bibliograf a Apndices e Apndice A: Primer contenido detallado . . . . . . . . . . . . . . . . . . . . . . . e Anexos Anexo A: Primer anexo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2 5 7 9 10 10 12 12 13 16 17 17 18 18
estar numeradas y tener t tulos relacionados con su contenido. Las pginas deben estar a numeradas y en la tabla de contenido debe aparecer el t tulo de cada seccin y el o nmero de pgina donde comienza la seccin. Puede verse la tabla de contenido de u a o esta gu para ms detalles de cmo luce. Justo antes de los apndices, debe venir la a a o e seccin de referencias o bibliograf si la hay; generalmente los informes acadmicos si o a e tienen esta seccin. o 3. T tulo del informe. El t tulo debe guardar una estrecha relacin con el contenido o del trabajo y describir su esencia abreviadamente. Hay que mantener un balance entre la longitud del t tulo y la informacin que provee sobre el trabajo, de modo que sea lo o ms corto y lo ms informativo posible. a a 4. Extensin del informe. Un informe tcnico debe ser conciso y claro, es importante o e evitar frases o palabras innecesarias, por lo cual su extensin no debe ser muy larga. o Dependiendo de la audiencia a quien est dirigido, puede ser muy corto, por ejemplo si e va dirigido a la gerencia alta o a alguien quien slo debe obtener una visin general con o o el informe, en este caso puede ser tan corto como de dos pginas y no debe pasar de a cinco (5). En cambio, si la audiencia es un jurado que debe evaluar el trabajo descrito en el informe, ste s puede ser un poco ms extenso, una longitud razonable en este e a tipo de informe es de 40 pginas. a Algunos consejos iniciales y que aplican a todo el informe se listan a continuacin: o Es importante cuidar la redaccin, la puntuacin y la ortograf al escribir el informe. o o a El contenido debe quedar muy claro, por lo tanto es fundamental que la redaccin o ayude a comprender el contenido rpidamente. Los errores de redaccin o edicin del a o o informe pueden ser un impedimento para que el lector entienda el contenido. El trabajo puede ser excelente, pero si est reportado con errores no se puede apreciar su calidad. a Por eso es tan importante prestarle atencin a la forma como se van a presentar los o resultados de un trabajo o tarea. Si se van a incluir listas muy largas de temes en el informe, es importante que esas listas estn ordenadas de alguna forma. Por ejemplo, cuando se construye el diccionario e de datos de una base de datos, es importante presentar las entidades o clases y las interrelaciones o asociaciones en un orden preestablecido que puede ser alfabtico por e nombre de entidad o clase, o puede ser una numeracin asignada previamente a cada o 3
elemento y especicada antes de presentar los elementos. Lo importante es que el lector pueda encontrar la descripcin de cada elemento sin mucho esfuerzo y que se o establezca un orden de presentacin de las cosas que ayude a entender el contenido y o no lo entorpezca. En general cualquier lista muy larga, es decir, de ms de 7 elementos, a debe ser enumerada, en otras palabras, cada elemento de la lista debe tener asignado un nmero o letra. u El ndice general o tabla de contenido del informe es una herramienta muy util para entender la organizacin y el contenido del mismo. Un informe cuya longitud sea mayor o de ocho (8) o diez (10) pginas debe necesariamente incluir un a ndice de su contenido. El resto de la gu est organizado como sigue: en el cap a a tulo 2 se describen los lineamientos para escribir la introduccin al informe, en el cap o tulo 3 se presenta una gu sobre a cmo organizar el contenido del informe, el cap o tulo 4 explica cmo escribir las conclusiones o del informe, en el ultimo cap tulo se describe lo relativo a la bibliograf y a la inclusin de a o guras y tablas, y se incluyen algunas recomendaciones generales sobre redaccin, puntuao cin y otros. Finalmente, se incluyen dos cap o tulos, uno para los apndices y otro para los e anexos, a modo de ilustracin de cmo luce el informe cuando se agregan esos aspectos. o o
informe por cap tulos el contenido de cada cap tulo deber ser ms largo que los cap a a tulos incluidos en esta gu Si los cap a. tulos son muy cortos ello puede ser una indicacin de que o deber ser secciones en lugar de cap an tulos y quizs haya algn problema con la organizacin a u o del informe.
desarrollo de un sistema de informacin, se pueden incluir secciones o cap o tulos para: anlisis del problema, diseo del sistema, implementacin y pruebas. Asimismo, si se a n o trata del desarrollo de una base de datos, las divisiones para presentar la solucin o pueden corresponder a las fases de desarrollo de la misma. Los t tulos de los cap tulos no deben ser los que se dieron arriba, sino unos t tulos apropiados de acuerdo al problema resuelto durante la pasant en esta gu se utilizaron t a, a tulos que nos permitieran explicar los contenidos de los cap tulos, pero la seleccin de los t o tulos adecuados es un asunto delicado, que no debe ser hecho apresuradamente. En el caso de un proyecto de grado, el libro se puede dividir tambin en cap e tulos. Como en el proyecto no hay una empresa, el cap tulo siguiente a la introduccin a menudo o describe los fundamentos tericos del trabajo realizado. Tambin debe haber un cap o e tulo de planteamiento del problema y uno o ms cap a tulos de la solucin. o Un consejo adecuado es consultar con la persona que ha guiado su trabajo sobre la escritura del informe. Esa persona puede ayudarlo a resolver problemas espec cos de organizacin o del informe. Adicionalmente, se pueden consultar los informes de otras personas que hayan realizado un trabajo similar o que hayan sido supervisadas por la misma persona; trate de consultar ejemplos de informes buenos, es decir, que hayan obtenido una calicacin alta. o
5.1.
Toda fuente citada en el contenido del informe, debe ser especicada completamente en una seccin denominada bibliograf referencias bibliogrcas o simplemente referencias. La o a, a bibliograf generalmente se reere slo a libros utilizados en el trabajo, sin embargo las a o referencias s pueden incluir art culos de revistas, sitios web, libros y otros y se especican completamente, incluyendo nmero de pginas, fecha de publicacin, autores, t u a o tulo completo, y los detalles de dnde apareci. Si se trata de un art o o culo en una revista (publicacin o peridica), se deben colocar, adems de los datos del art o a culo en cuestin, el t o tulo de la revista, el volumen, el nmero y el ao. Es esencial utilizar una notacin estndar para enumerar u n o a las referencias, hay varios estilos usados en la literatura actual. Uno de estos estilos es listar las referencias en orden de cita dentro del texto y numerarlas del [1] hasta el ultimo nmero u necesario para numerarlas todas. Otro estilo es ordenarlas por el apellido del primer autor y la manera abreviada de hacer referencia a cada una de ellas es con las 3 4 primeras letras o 10
del apellido del primer autor, o con las iniciales del primer apellido de todos los autores y al nal de estas letras los dos ultimos d gitos del ao de publicacin de la referencia. Por n o ejemplo, si se va a citar el art culo DIA: A Document Interrogation Architecture de Soraya Abad-Mota y Paul Helman, se puede hacer referencia a ste como: [1] o como [AH02]. En e ingls es comn encontrar la palabra references para la seccin que contenga las referene u o cias, sin embargo en castellano es ms comn utilizar la palabra bibliograf para ello, an a u a u cuando sta incluya referencias a fuentes que no son libros, como se hace en esta gu por e a, ejemplo. Todas las fuentes que aparecen en la bibliograf deben ser citadas en alguna parte del a texto, por otro lado, todas las fuentes citadas en el texto deben aparecer completas en la seccin o cap o tulo de Bibliograf Cuando se cita una fuente, basta con hacer referencia a la a. numeracin utilizada en la bibliograf no se debe copiar dos veces la referencia completa, o a, para eso est la seccin de bibliograf para colocar la cita completa. Adems de colocar la a o a, a numeracin de la cita, uno puede hacer referencia al autor o autores de la misma, como se o hace en la siguiente frase: Bernstein et al. en [2] tratan el tema del control de concurrencia y recuperacin de bases de datos. Esta cita adems ilustra cmo se puede hacer referencia o a o a una fuente de varios autores, se puede dar el nombre del primer autor y las palabras et al., las cuales constituyen una abreviatura de et alia que signica los otros en lat n. Por cierto, el libro anteriormente mencionado, est agotado y ya no se imprime ms, sin a a embargo sus autores han colocado una copia electrnica que puede utilizarse gratis para o nes acadmicos en la siguiente direccin: http://research.microsoft.com/pubs/ccontrol/. e o Es importante recordar que el informe lo redacta el autor del mismo utilizando sus propias palabras, si es necesario colocar citas textuales de trozos redactados por otros autores es obligatorio colocar esos trozos entre comillas ( ) y citar la fuente donde apareci el trozo. o Nunca se debe colocar sin comillas, ni dar la impresin de que uno escribi algo que en o o realidad no ha escrito. Por ejemplo, cuando en una pasant larga, se va a describir a la a empresa es t pico usar algn folleto o pgina web de la empresa, si se van a usar trozos u a de esa descripcin en el informe, se deben colocar entre comillas y citar la fuente, la cita o completa del folleto o la pgina web debe aparecer en la bibliograf a a. Finalmente, como ejemplos de varios tipos de fuentes se incluyen en la Bibliograf las a siguientes referencias: [3], [4], y [5].
11
5.2.
Algunos informes requieren la inclusin de guras o de tablas, las cuales deben estar o numeradas. Puede utilizarse una numeracin separada para cada cosa, es decir una numeo racin para las guras y otra aparte para las tablas. Al pie de cada gura o tabla debe o aparecer una nota que diga Figura #: t tulo de la gura o Tabla #: T tulo de la tabla, respectivamente. (Por cierto, acabamos de ver un ejemplo de cmo usar el respectivamente o de manera correcta.) Tanto las guras como las tablas deben anunciarse y explicarse en el texto y deben ir ubicadas cerca del texto que las describe. Generalmente, despus de la tabla de contenido de todo el informe, se colocan el e ndice de guras, donde para cada gura se coloca su t tulo y la pgina donde aparece, y el ndice a de tablas, donde para cada tabla se indican su t tulo y la pgina donde aparece. a Como nota nal, es util anunciar que si se va a elaborar un informe largo donde se tomen en cuenta todos los aspectos de presentacin descritos en esta gu pueden revisar el paquete o a, LaTex de formateo de texto, que es muy poderoso y con el cual se han publicado muchos libros. Esta gu fue realizada en LaTex. a
5.3.
Antes de entregarle su informe a alguien, por favor LEALO, un error o dos de transcripcin, inclusive de ortograf se le perdonan a quien sea, pero una hoja plagada de typos o a (es como se dice errores de transcripcin en ingls) es desesperante. Se puede ver que estoy o e escribiendo esto al calor de un par de informes de pasant y libros de tesis, donde el autor a fue bastante descuidado y era dif entender cosa alguna, por los errores de forma que descil concentran tanto. Una cosa es un borrador, algo que se sabe no est en su versin nal, pero a o otra muy distinta es un documento donde se nota de lejos que el autor no invirti mucho o tiempo en el cuidado de la forma y de hecho ni siquiera lo ley antes de entregarlo! o An continuacion voy a colocar un parrago que escribire a toda velocidad y sin nigun tipo de cuidado sobre los que sale escrito y eusds me idran como se siente leerlo. No es slo por o los acentos pues voy a poner unos cuantaos para matizarm, pe son los tipeor, no les parece absul,utamebnte desesperante tratar de leer algo as ? Esta seccin es un pedido de todo corazn, de parte de los que tenemos que leer muchos o o 12
informes, para que por favor, piensen en el lector y traten de aliviarle la vida escribiendo con un poquito ms de cuidado y revisando lo escrito muy bien antes de entregarlo. a En general los lectores, por el hecho mismo de estar leyendo su documento, lo hacen de muy buena gana y estn dispuestos a ayudar a que la versin nal quede de la mejor manera a o posible. Si Ud. est leyendo esta gu seguramente es porque est escribiendo algn tipo de a a a u informe por el cual alguien le va a dar algo a cambio, una buena nota, una remuneracin, o un aumento o un ascenso, entonces, no vale la pena dedicarle un poquito ms y tratar de a hacerlo lo mejor posible? Si Ud. est consciente de que tiene problemas para escribir o que a comete muchos errores, por qu no le dedica ms tiempo a la escritura del informe para e a poder revisarlo bien y corregir los errores m nimos, visibles en una primera lectura? No lo deje as como le sale a la primera, que se nota mucho cuando no se le invierte el tiempo necesario. No se lo deje todo al lector, por favor.
5.4.
Recomendaciones Generales
En esta seccin se incluyen algunos consejos utiles sobre redaccin, ortograf puntuacin o o a, o y otros aspectos de la escritura. Un error muy frecuente en castellano es el abuso del que y el uso del que galicado. Como ilustracin del primero veamos los siguientes ejemplos: En la gura 6 se puede o apreciar que el planteamiento de Highsmith se inclina a una metodolog que puede a dar ms vueltas, pero que llega a un resultado que es el que realmente necesita y va a a utilizar el usuario. En una sola oracin se usa cinco veces el que. o El uso del que galicado ocurre cuando se utiliza el que en lugar de cual, cuales, quienes, donde, etc. En lugar de: ...denidas por el Centro de Costo al que la persona est adscrita, se deber decir: ...denidas por el Centro de Costo al cual la persona a a est adscrita. a Si se utilizan trminos forneos en la redaccin, como por ejemplo palabras en un e a o idioma distinto al del documento, o trminos tcnicos con un signicado muy especial, e e stos deben colocarse en itlicas o entre comillas. e a Glosario de trminos. Si en el documento se utilizan muchos trminos tcnicos es necee e e sario construir un glosario de trminos, donde se dena cada uno de ellos. El glosario se e 13
incluye despus de la tabla de contenido del informe y despus de los e e ndices de tablas y guras. Abreviaturas. Se pueden usar, pero la primera vez que aparezca el trmino completo e se debe explicar cul es la abreviatura que se va a emplear, esto es especialmente util a para organizaciones con nombres muy largos. Uso de maysculas. En castellano slo se utilizan las maysculas para los nombres prou o u pios y en algunos otros casos, es bueno consultar el diccionario o un libro de gramtica a cuando hay dudas al respecto. Al respecto, sugerimos el uso del Diccionario Panhispnico de dudas, el cual adems de estar publicado en papel, tambin est disponible en el a sitio web: www.rae.es. Donde, relativo a si escribir o no los nombres de las reas en maysculas dice: 4.24. a u Los sustantivos y adjetivos que forman el nombre de disciplinas cient cas, cuando nos referimos a ellas como materias de estudio, y especialmente en contextos acadmie cos (nombres de asignaturas, ctedras, facultades, etc.) o curriculares: Soy licenciado a en Biolog Me he matriculado en Arquitectura; El profesor de Clculo Numrico es a; a e extraordinario. Fuera de los contextos antes sealados, se utiliza la minscula: La men u dicina ha experimentado grandes avances en los ultimos aos; La psicolog de los nios n a n es muy complicada. Los nombres de asignaturas que no constituyen la denominacin o de una disciplina cient ca reciben el mismo tratamiento que si se tratase del t tulo de un libro o de una conferencia, esto es, solo la primera palabra se escribe con mayscula: Introduccin al teatro breve del siglo XVII espaol, Historia de los sistemas loscos. o n o Tambin se escriben con mayscula los sustantivos y adjetivos que dan nombre a cure u sos, congresos, seminarios, etc: 1.er Curso de Cr tica Textual, XV Congreso Mundial de Neonatolog Seminario de Industrias de la Lengua. a, Palabras traducidas literalmente de algn idioma y que no existen en castellano. En u a reas tcnicas es muy comn traducir, por ejemplo del ingls, algunos trminos que e u e e no existen en castellano. Un ejemplo de esto es monitoreo que viene de traducir literalmente monitor (estas son itlicas, por cierto), pero que no existe en castellano, a es ms adecuado utilizar la combinacin de palabras: supervisin y control en lugar a o o de monitoreo. Correr es otra palabra usual en computacin como traduccin literal de o o run aplicado a un programa, correr el programa no es la forma correcta de escribir tcnicamente al respecto, es mejor escribir ejecutar un programa. El Diccionario de la e Real Academia de la Lengua Espaola est disponible electrnicamente en www.rae.es n a o 14
y es una fuente muy util para saber si una palabra existe en el idioma, ver cmo se o escribe y cmo se acenta. o u Otras palabras que no existen: mapear, extendible (pero si existe extensible), ranking (se puede usar posicionamiento u ordenamiento), permisolog a. Al denir no se pueden utilizar las mismas palabras que se estn deniendo. Por ejema plo, para denir extraccin de informacin no se puede decir que su objetivo es extraer o o informacin de un documento, pues no se est diciendo nada con esa frase que ayude o a a entender lo que es. Redundancia. Un manejador de base de datos relacional es un manejador que se basa en el concepto de relacin. El modelo relacional de Codd se basa en relaciones.... o Muchas veces se utiliza el trmino relacin o alguno de sus derivados en estas dos orae o ciones, es necesario reescribirlas para evitar la redundancia. Adicionalmente, las dos oraciones estn diciendo bsicamente lo mismo. Una redaccin ms adecuada pudiera a a o a ser la siguiente: El modelo relacional de Codd se basa en el concepto matemtico a de relacin. Este modelo di lugar a los manejadores de base de datos relacionales, o o conocidos por sus siglas en ingls como RDBMS (relational database management syse tems). En algunos casos, por razones pedaggicas, uno puede utilizar la redundancia o para explicar algo, pero no se debe abusar de ella. Acentos en este o esta. Slo se acentan ste o sta, cuando se utilizan como pronomo u e e bres. Por ejemplo, ... la base de datos; sta se debe disear tomando en cuenta...., e n en cambio, en las siguientes oraciones: Esto quiere decir que esta vez..., En esta primera versin. la palabra esta no lleva acento. o Signos de puntuacin. Es importante recordar que en castellano, las interrogaciones o deben ir encerradas entre los s mbolos y ?; las expresiones admirativas se encierran entre los s mbolos y !. Es decir, hay un s mbolo que abre la frase y otro que la cierra, no es como en ingls donde basta un slo s e o mbolo al nal de la frase.
15
Bibliograf a
[1] Soraya Abad-Mota and Paul Helman, DIA: A Document Interrogation Architecture. En Proceedings del Text Mining Workshop dentro del marco de la Sixth Pacic-Asia Conference on Knowledge Discovery and Data Mining (PAKDD-02) celebrado en Taipei, Taiwan el 6 de mayo de 2002, pp. 35-45. [2] P.A. Bernstein, V. Hadzilacos y N. Goodman, Concurrency control and recovery in Database Systems. Addison-Wesley 1987. [3] B. Chandrasekaran, J.R. Josephson and V. R. Benjamins, What are Ontologies, and Why do we need them?. IEEE Intelligent Systems and their applications, Jan/Feb 1999, pp. 20-26. [4] R. Elmasri and S. B. Navathe, Fundamentals of Database Systems. Addison-Wesley 1999. Third edition. [5] S. Human, Learning information extraction patterns from examples. Cap tulo del libro Symbolic, Connectionist, and Statistical Approaches to Learning for Natural Language Processing, pp. 246-260, Springer-Verlag 1996, editores S. Wermter, E. Rilo and G. Scheler. Lecture Notes in Articial Intelligence Series.
16
Apndices e
Apndice A: Primer contenido detallado e
17
Anexos
Anexo A: Primer anexo
18