CURSO 2011/12

DOCUMENTACIN TCNICA
Proyectos (Sonido e Imagen)

Pedro Garca del Pino Martina Eckert

Departamento de Ingeniera Audiovisual y Comunicaciones EUIT Telecomunicacin Universidad Politcnica de Madrid

Elaboracin de documentacin tcnica

1 . Introduccin
La elaboracin de documentacin (informes, manuales, procedimientos, propuestas) es parte esencial del trabajo del ingeniero. En particular, el informe tcnico es una va de comunicacin de ideas, resultados de estudios o noticias en general. Es el medio de transmisin y documentacin ms utilizado y resulta siempre necesario para apoyar decisiones tcnicas o econmicas. El informe tcnico se puede definir como una exposicin ordenada y exhaustiva de datos o hechos dirigidos a alguien, sobre un tema determinado o sobre el estado de una cuestin. Dicho de otra manera, un documento que describe el progreso y resultados de un estudio tcnico, una investigacin o el estado de un problema. Este documento se enfoca en los informes tcnicos que, en el mbito de los proyectos de ingeniera, son requeridos en muchos momentos de la vida de los mismos, desde la necesidad de informar a los superiores sobre la evolucin de un trabajo hasta la conveniencia de aportar datos que fundamenten decisiones de tipo tcnico. Pero la mayora de lo expuesto aqu es vlido para otro tipo de documentacin tcnica (manuales, artculos de investigacin, patentes), de manera que puede servir como gua de escritura general. En mbitos relacionados con actividades de I+D+i, el informe puede ser el modo de hacer partcipes a otros tcnicos o cientficos de hallazgos, desarrollos o nuevas ideas e investigaciones. Un claro ejemplo son los artculos en revistas especializadas y las ponencias en congresos. El informe debe ajustarse a ciertas normas formales que aseguren la consecucin de sus objetivos como va de transmisin de datos y conocimientos. A continuacin se repasarn algunos de estos aspectos.

2 . Cuestiones previas
Antes de empezar a escribir es conveniente preguntarse estas cuestiones: Qu queremos contar? Es decir, cul ser el contenido del informe, lo que queremos decir y lo que queremos excluir. A quin est dirigido el informe tcnico? Debe el lector tomar una decisin a partir del informe? El informe siempre est dirigido a una persona o a un equipo de personas, por lo que su redaccin estar condicionada por el perfil de los lectores potenciales. De la misma manera, el informe debe ser redactado de modo diferente si se elabora a requerimiento del destinatario o si la iniciativa ha partido del ingeniero que lo redacta. Cul es el propsito del informe tcnico? Por ejemplo, informar a nuestro jefe sobre el estado del proyecto, solicitar recursos adicionales, persuadir a un cliente sobre las ventajas de nuestro diseo, analizar diferentes alternativas El enfoque del documento, an tratndose de los mismos datos, ser distinto en funcin del objetivo que perseguimos con la redaccin del mismo. Cul es la estructura ms adecuada para el documento?, cul debera ser la extensin mxima del informe? Aunque existen mltiples maneras de abordar la redaccin de un informe, todos deberan regirse por unos principios bsicos: 1

Elaboracin de documentacin tcnica

Utilizacin de lenguaje claro, conciso y preciso. El informe debe poder leerse con facilidad, por lo que hay que cuidar tanto los aspectos formales y visuales (tipos de letra, interlineado, mrgenes) como el estilo. El aumento forzado de la extensin no beneficia a la calidad del informe. Objetividad. Los trabajos de ingeniera, a pesar de lo que pudiera pensarse, no tienen garantizada la objetividad. Continuamente se nos pide que extraigamos conclusiones de nuestros estudios o que elijamos entre varias posibles alternativas. Cualquier manera de exponer unos datos objetivos tiene connotaciones que apuntan en una u otra direccin. An as, es una obligacin del ingeniero evitar la parcialidad, sin dejarse influir por las circunstancias. Argumentacin detallada, fundamentada y rigurosa. El discurso del informe debe seguir un razonamiento minucioso. Cuando se mencionen bondades o faltas, es justo fundamentarlas en argumentos slidos. En todo caso es mejor no abusar de los juicios de valor, en los que se califica positivamente o negativamente los resultados de nuestro estudio o el de otros autores. Deben evitarse construcciones como: o El modelo se ajusta a la perfeccin a los datos experimentales. o Nuestros resultados son mucho mejores que los de Smith. Pueden sustituirse por: o El grado de ajuste del modelo es inferior al error de medida. o Los resultados del estudio parecen mejorar los obtenidos por Smith. No hay por qu escribir el informe en el mismo orden en el que se va a leer. A menudo, la introduccin es la tarea ms complicada porque se necesita tener una idea clara de la totalidad del trabajo y del enfoque con el que se va a orientar el escrito. Es mejor comenzar por la parte del informe que sea ms directa; por ejemplo, metodologa, procedimientos en ellas no hay interpretacin. En cuanto a la extensin, un informe corto es mejor que uno largo si consigue transmitir la misma informacin. Si podemos decir lo mismo en 2000 palabras que en 5000, con seguridad es mejor utilizar 2000. Eliminar cosas redundantes e innecesarias.

3 . El ttulo del informe

La eleccin del ttulo del informe tcnico es una cuestin de primera magnitud. El ttulo genera en el lector ciertas expectativas que ser necesario satisfacer. Adems, puede dar el tono general del escrito. Un buen ttulo debe tener las siguientes caractersticas: Comprensible. Entenderse con facilidad y servir de introduccin al contenido del trabajo. Claro. Evitar ttulos imprecisos, desorientadores, excesivamente recargados o extravagantes. Huir de la vaguedad, de la generalizacin. Asegurarnos que refleja el contenido. 2

Elaboracin de documentacin tcnica

Descriptivo a la vez que conciso. Debe describir con la mayor exactitud posible el contenido del informe pero sin que la extensin sea excesiva. Si, an as, el ttulo resulta demasiado complejo puede recurrirse a la utilizacin de un subttulo; esto no siempre es posible cuando el informe debe cumplir una serie de requisitos formales. En el orden lingstico se aconseja el predominio de los sustantivos, utilizando los adjetivos, frases hechas o locuciones adverbiales slo en el caso de que se hagan imprescindibles. En la medida de lo posible evitar que el ttulo comience con expresiones del tipo: un estudio de, un experimento sobre, anlisis de, etc. Como recomendacin prctica es conveniente probar diversas formulaciones; no siempre el primer ttulo escogido es el definitivo sino que, a menudo, se retoca a lo largo de la generacin del resto del documento.

4 . Estructura del informe

La estructura general de un informe puede adaptarse al esquema siguiente, si bien puede que no todos las partes sean necesarias: Portada. Resumen ejecutivo. ndice o tabla de contenido. Lista de figuras y tablas. Cuerpo del informe. Referencias. Anexos.

Fig. 1. Estructura tpica de un informe tcnico 4.1. Portada La primera hoja o portada del informe tcnico deber contener el ttulo (y subttulo) del proyecto, el nombre o nombres completos de los autores (incluyendo si es preciso su titulacin, procedencia y direccin de contacto) y la fecha de elaboracin. En algunos casos ser necesario incluir un nmero de referencia. Tambin es habitual que figure el logotipo de la empresa o institucin a la que pertenece el autor.

Elaboracin de documentacin tcnica

4.2. Resumen ejecutivo Todo informe tcnico debe contener un resumen que se presentar inmediatamente despus de la informacin de portada. Su longitud no suele sobrepasar el 10% de la longitud del informe. En l deben resumirse los puntos clave y las conclusiones del informe. Algunas cuestiones bsicas a tener en cuenta en la redaccin del resumen ejecutivo son: Debe definir el objetivo, describir el mtodo empleado y resumir las conclusiones. Constituye un texto completo e independiente, no es una parte de un documento ms amplio. En el cuerpo del informe no puede hacerse referencia al resumen. Debe proporcionar una visin completa, de modo que los lectores puedan decidir si estn interesados o no en leer cada seccin del informe. Debe escribirse con frases completas (no lenguaje esquemtico). No incluye figuras, tablas ni frmulas, salvo que sea completamente imprescindible. Los trminos poco comunes, las abreviaturas y los smbolos deben definirse en la primera aparicin. En el caso de una publicacin cientfica este apartado se sustituira por un resumen (abstract). Lo expuesto de aqu en adelante es vlido para todo tipo de redacciones cientficas. 4.3. Tabla de contenido. Lista de figuras y tablas Se debe realizar una tabla de contenido si el tamao del documento es amplio, dividindolo y clasificndolo lo ms posible. Debe constar de los ttulos de las principales subdivisiones del informe y los anexos, junto con el nmero de pginas en las que aparecen. Suele adoptarse la numeracin decimal como criterio universal de clasificacin. El ndice ha de ser un reflejo exacto del contenido del trabajo, aunque su extensin depender de si se consignan todos los aspectos o slo los ms representativos. En informes de cierta envergadura es habitual aadir un listado de las figuras y tablas, de manera que los lectores puedan localizarlas rpidamente. No siempre hay que incluir el ttulo completo de la figura o la tabla, puede abreviarse. Cuando el informe contenga signos, smbolos, unidades, abreviaturas, acrnimos o trminos tcnicos que puedan no ser comprendidos por los posibles lectores, es una buena prctica definirlos en un glosario. An as, no debe omitirse la explicacin de estos smbolos cuando aparezcan por primera vez en el texto. 4.4. Cuerpo del informe El cuerpo del informe constituye la parte fundamental de la obra y la ms compleja, ya que en ella se da a conocer el contenido del estudio. Su estructura y presentacin deben facilitar la lectura del documento y contribuir a transmitir su mensaje al destinatario. Para que el lector aprecie cierta consistencia lgica, ser muy til distribuir el texto en captulos o secciones. Una vez realizado lo anterior debemos asegurarnos de que cada divisin tiene sentido por s misma y a la vez mantiene cierta unidad global con el resto de captulos. Una posible estructura de la exposicin es la siguiente: 4

Elaboracin de documentacin tcnica

Introduccin. Anunciar y presenta el tema para ganar la atencin del lector. Establece brevemente el alcance y objetivos del trabajo, su relacin con otros trabajos y el enfoque general. Ha de ser breve y clara, no debe repetir o parafrasear el resumen, ni dar detalles tcnicos sobre la teora, mtodos o resultados. De ningn modo puede anticipar las conclusiones. Desarrollo (ncleo del informe). Debe dividirse en captulos numerados que cubran aspectos tales como: bases tericas, mtodos y procedimientos, resultados y discusin. Las explicaciones deben ser suficientemente detalladas para que un especialista en la materia reproduzca las etapas del estudio sin dificultad, pero los detalles completos, demostraciones matemticas, etc. deben presentarse en los anexos. Una divisin tpica en un informe de cierta envergadura es la siguiente: o Antecedentes. Planteamiento del problema. o Fundamentos tericos. o Mtodos y procedimientos empleados. o Resultados y discusin de los mismos. Conclusiones y recomendaciones. Las conclusiones surgen como consecuencia de los argumentos expuestos en el desarrollo del trabajo. Pueden incluir datos cuantitativos pero sin dar excesivos detalles de los resultados expuestos anteriormente. Las recomendaciones son manifestaciones concisas de alguna accin futura que parezca necesaria como resultado directo de las conclusiones alcanzadas o de alguna experiencia en el curso del trabajo. As pues, el apartado de conclusiones y recomendaciones debe incluir: o Aspectos positivos, tales como inters, novedad, oportunidad o Aspectos que voluntariamente se han dejado al margen del trabajo. o Cuestiones pendientes y relaciones del trabajo con otros temas. Es importante considerar que las conclusiones o recomendaciones de un informe no son incuestionables. A menudo se trata de opiniones discutibles que emitimos en base a nuestra experiencia tcnica, con el objetivo de aportar conocimientos u opiniones sobre una cuestin abierta. En tal caso conviene no ser demasiado categrico en afirmaciones discutibles. Al final del cuerpo del informe pueden incluirse agradecimientos relativos a ayudas en la realizacin del trabajo y en la preparacin del informe. 4.5. Referencias Siempre que se cita o se utiliza informacin de otras fuentes debe indicarse su procedencia. Lo ms habitual es incluir todas las fuentes en una lista al final del informe. En el apartado 6.8 se explicarn las formas ms habituales empleadas en documentacin tcnica para escribir las referencias.

Elaboracin de documentacin tcnica

4.6. Anexos Como anexos al informe se incluirn los clculos y estudios en los que nos hemos apoyado y, en general, todas aquellas partes del estudio que, por extensas o complejas, puedan independizarse sin restar coherencia a la exposicin. Algunos ejemplos son: Material que, insertado en el cuerpo del informe, alterara la presentacin ordenada y lgica del trabajo. Material especial que no puede ser colocado adecuadamente en el cuerpo del informe a causa de su tamao o del mtodo de reproduccin utilizado: mapas, fotografas originales Informacin demasiado tcnica para un lector ordinario pero que puede ser valiosa para un especialista en la materia. Ilustraciones o tablas suplementarias. Figuras o tablas que no se necesitan para una comprensin inmediata del texto, pero que proporcionan ejemplos complementarios. Descripcin de equipos, tcnicas o programas de ordenador utilizados en el estudio. Los anexos se indexan tpicamente por letras maysculas (Anexo A, Anexo B) y deben considerarse como entidades independientes, por lo que deben dividirse separadamente en captulos, apartados y las ilustraciones, tablas, referencias y ecuaciones deben numerarse de nuevo con cada anexo.

5 . El estilo narrativo
Un documento tcnico consta de componentes: texto (palabras, que se agrupan en frases, prrafos y apartados), elementos grficos (grficas, esquemas, fotografas) y datos (ecuaciones, tablas). Todos ellos colaboran en la transmisin de la informacin. Se comentan a continuacin algunas tcnicas estilsticas simples relacionadas con estos componentes que ayudan a expresar las ideas de forma clara. 5.1. Las palabras Emplear palabras sencillas, ms fcilmente entendibles por el lector. La utilizacin de palabras rebuscadas puede generar una distorsin del significado del mensaje, haciendo perder tiempo al lector y poniendo en peligro la eficacia del documento. Es mejor emplear una palabra simple que una parfrasis (mejor controlar que hacer un control). Es preferible utilizar trminos tcnicos en castellano a cualquier trmino extranjero o cultismo, pero siempre que exista una traduccin adecuada y aceptada de forma general y no sea un neologismo. En documentos que sern ledos exclusivamente por otros ingenieros del mismo sector es natural emplear lenguaje o jerga profesional. No obstante, si se transciende ese mbito profesional es necesario utilizar un lenguaje ms cercano al habitual, en el que los trminos empleados se expliquen con precisin, claridad y sencillez. Los adjetivos y adverbios matizan o aclaran el sentido de otras palabras que forman el mensaje; son tiles pero no debe abusarse de ellos. Los superlativos casi siempre resultan 6

Elaboracin de documentacin tcnica

contraproducentes; slo es aconsejable su utilizacin cuando se pueden relacionar directamente con la realidad o son muy verosmiles. 5.2. Las frases En la redaccin de documentacin tcnica las frases deben escribirse con naturalidad y siguiendo el orden lgico de sujeto + verbo + complementos. La alternancia de distintos tipos de frases cortas, largas, enunciativas, expositivas da ritmo y hace ms fluida la lectura, evitando la monotona. Evitar frases excesivamente largas. La excesiva longitud aumenta las posibilidades de que la oracin tenga un doble sentido no deseado, o de cometer incorrecciones gramaticales, como faltas de concordancia. Conviene usar el impersonal, evitando los pronombres personales yo o nosotros o los pronombres posesivos mo y nuestro. Esta regla se ha flexibilizado ltimamente, sobre todo cuando se quieren diferenciar las ideas o resultados del autor, del trabajo de otros investigadores. En todo caso, aunque el trabajo tenga un slo autor, se usan los pronombres nosotros o nuestros. 5.3. Los prrafos La divisin del escrito en prrafos ayuda al lector a seguir el argumento, facilitando la comprensin del documento mediante la secuenciacin de su contenido. Si un texto es muy largo y no se divide en prrafos la lectura resulta fatigosa y montona. Adems, la divisin hace ms atractiva la visualizacin de la pgina. Cada prrafo debe conducir de manera natural al siguiente, de lo contrario el lector puede verse dentro de una maraa de informacin mal estructurada. Cuando exista una falta de relacin entre prrafos es aconsejable incluir un prrafo de transicin que resuma las ideas ms importantes del anterior y le d paso al siguiente. Estos prrafos robustecen el texto y dan impresin de orden y coherencia. 5.4. La divisin en apartados, captulos o secciones Una buena estructura se caracteriza tambin por la utilizacin de ttulos y subttulos, lo cual proporciona una adecuada visin global de un solo vistazo. Los ttulos intermedios deben ser: Explcitos. Deben permitir conocer de un vistazo el tema del texto que viene a continuacin. Breves. Ms de una lnea es siempre excesivo. Comprensivos. Ordenados lgicamente. Criterio determinado y uniforme. 5.5. Las ilustraciones Las fotografas o las ilustraciones mapas, grficos, planos, dibujos, esquemas, etc. son mensajes visuales que suelen resumir la informacin de forma clara y rpida y, por 7

Elaboracin de documentacin tcnica

consiguiente, se utilizan para sintetizar una larga explicacin. Aportan al escrito claridad y atractivo, consiguiendo reforzar la comunicacin. 5.6. Siglas y acrnimos Las siglas y acrnimos deben definirse la primera vez que se utilicen, aadiendo la traduccin si estn en ingls. Hay dos maneras posibles de introducir las abreviaturas, si bien en el documento se debe utilizar una nica: abreviatura con la explicacin en parntesis, p.ej.: o La FPGA (Field Programmable Gate Array) de la firma XYZ o Los diseadores de ASICs (Application Specific Integrated Circuits o Circuitos Integrados para Aplicaciones Especficas) digitales usan lenguajes descriptores de hardware (HDL Hardware Description Language), tales como Verilog o VHDL1, para describir la funcionalidad de estos dispositivos. escrita enteramente con la abreviatura en parntesis, p.ej.: o obtenida mediante la asistencia a las III Jornadas Internacionales de la Universidad Politcnica de Madrid (UPM) sobre Innovacin Educativa y Convergencia Europea (INECE) Explicaciones ms amplias se pueden poner como nota al pie de pgina.

6 . Cuestiones formales
Un escrito tcnico debe reunir una serie de caractersticas que lo hagan atractivo a la audiencia a la vez que mantiene su carcter funcional. El aspecto visual de cualquier trabajo es muy importante: un trabajo mal presentado influye negativamente, mientras que una buena presentacin crea una expectativa favorable. En este apartado se tratarn algunas cuestiones relacionadas con la presentacin de los escritos tcnicos, indicando algunas precauciones y recomendaciones que deben seguirse para lograr que el documento sea ledo y comprendido sin dificultad por los lectores. 6.1. Numeracin de prrafos, epgrafes, ttulos y pginas La numeracin, dentro de un escrito tcnico, facilita cualquier referencia posterior al contenido, bien sea en una exposicin oral posterior o a lo largo del propio documento. El sistema ms utilizado en documentacin tcnica es la numeracin decimal, pudiendo emplearse en captulos, ttulos, subttulos, prrafos y hasta lneas. Un uso excesivo sera cansado para al lector y pierde su eficacia cuando la referencia se torna excesivamente compleja. No es habitual ni recomendable emplear ms de 3 4 niveles de profundidad para los ttulos.

VHDL es el acrnimo que representa la combinacin de VHSIC y HDL, siendo VHSIC el acrnimo de Very High Speed Integrated Circuit y HDL.

Elaboracin de documentacin tcnica

En la numeracin alfanumrica los distintos epgrafes se enumeran mediante un nmero y los subepgrafes mediante una letra del alfabeto en el orden que ste determina. Funciona bien slo en documentos simples. Las pginas del escrito pueden numerarse de modo continuo, desde la primera hasta la ltima pgina del documento, o mixto, empleando tanto el nmero de captulo como el nmero de orden de la pgina dentro de ese captulo. Puede omitirse la numeracin de portadas, contraportadas y el ndice si slo consta de una hoja. 6.2. Formato de la pgina En la configuracin de pgina de un editor de textos debe especificarse el tamao de papel, su orientacin y los mrgenes. Tambin puede definirse un encabezado y pie de pgina. En Europa suele emplearse papel tamao A4, orientacin vertical y una nica columna para toda la pgina. Es necesario indicar si la impresin se realizar a doble cara ya que, en ese caso, habr que definir formatos distintos para pginas pares e impares. Algunos valores tpicos de mrgenes de pgina son: Superior e inferior: 2,5 cm. Derecho: 2 cm. Izquierdo: 3 cm (puede ser algo mayor dependiendo del tipo de encuadernacin). En la impresin a doble cara los mrgenes se denominan interior y exterior. Sus medidas sern equivalentes a los mrgenes izquierdo y derecho, respectivamente. Es recomendable el uso de encabezados y pies de pgina, pues dan al documento un mejor aspecto visual. Adems, los encabezados pueden incluir informacin sobre el nmero y nombre de captulo en el que nos encontramos, por lo que son muy tiles para referenciar cuando el documento es largo. Si se imprime a doble cara lo habitual ser: Alternar el texto del encabezado entre pginas pares e impares. Por ejemplo, el encabezado de las pginas pares puede ser el ttulo del escrito, mientras que en las pginas impares puede ponerse el ttulo del apartado o captulo. El nmero de pgina puede ponerse tanto en el encabezado o en el pie de pgina pero en ambos casos en la parte exterior. Tanto en los encabezados como en los pies de pgina se emplear un tipo de letra distinto al del resto del texto. Adicionalmente, es muy habitual introducir una lnea de separacin (obsrvese, por ejemplo, el formato utilizado en estos apuntes). 6.3. Tipo y tamao de letra Existen multitud de tipos de letra diferentes que han sido creados para fines concretos: en unos casos para aprovechar el espacio, en otros para mejorar la legibilidad y en algunos con propsitos artsticos. Hay que procurar emplear un tipo de letra que sea atractivo al lector y no dificulte su lectura. No es aconsejable utilizar ms de dos tipos de letra diferentes.

Elaboracin de documentacin tcnica

Son ms fciles de leer las letras en minsculas que las maysculas. Los tipos de letra con serifa2 (Times Roman o Cambria) se leen mejor que las que van sin serifa (Arial o Calibri). Tambin se leen con dificultad las letras que imitan la caligrafa (Lucida Handwriting) y las decorativas (French Script). Las cursivas tambin dificultan la lectura cuando se emplean de manera excesiva: son tiles para resaltar un trmino extranjero, ttulos de libros o artculos y en metalenguaje. LOS TEXTOS LARGOS, ESCRITOS TOTALMENTE EN MAYSCULAS, SON MS DIFCILES DE LEER Y DE INTERPRETAR. El estilo negrita puede emplearse para enfatizar o, con discrecin, para seleccionar las palabras clave en un prrafo. Cuando se quiere remarcar algo, siempre es preferible utilizar negrita en lugar de subrayado, que ha quedado obsoleto y recuerda ms bien a las antiguas mquinas de escribir. Tampoco se usan comillas (estn reservadas para citas literarias). Si es necesario emplear palabras extranjeras, por ausencia de equivalente en castellano, pueden sealarse ponindolas en cursiva. No utilizar innecesariamente barbarismos que tienen sustituto. La distancia entre las letras y entre las palabras tambin influye en la legibilidad. Las letras que forman las palabras no deben estar excesivamente juntas, sobre todo, en los tipos de letra que no tienen serifa. Las palabras deben estar lo suficientemente separadas para que quepa entre ellas, con holgura una "a" minscula de este mismo tipo y tamao. En cuanto al tamao 12 puntos es adecuado para escritura en lnea continua y 11 puntos para escribir a dos columnas. Hay que advertir que dos fuentes distintas pueden tener tamaos reales diferentes aunque especifiquemos el mismo nmero de puntos (comprese, por ejemplo, Arial 12 puntos y Times New Roman 12 puntos). El color (un segundo color adems del negro) debera utilizarse con moderacin en un documento tcnico ya que la impresin de un documento que contiene fuentes en color es ms cara y lenta. En muchas ocasiones habr restricciones externas que lo impidan. A cambio, el color puede captar la atencin del lector con ms facilidad, permitiendo remarcar aquellos aspectos que son ms importantes. Es especialmente til en los encabezados, para destacar trminos especiales y en la edicin de notas al margen. 6.4. Formato de los prrafos Para establecer la distancia entre lneas de texto se suele utilizar la regla del interlineado del 120%: por ejemplo, si un texto est escrito en letra de cuerpo de 10 puntos, se emplear un interlineado de 12 puntos3. Nunca hay que superar el 150%.

Serifa o serif. Las tipografas con serifa (serif) son las que llevan remate en los extremos. Las tipografas sin serifa (sans serif del francs sans sin), tambin llamadas de palo seco, se caracterizan por la ausencia de remates.
3

Aunque en los procesadores de texto es ms habitual que el interlineado se exprese en nmero de lneas (1 lnea: sencillo, 2 lneas: doble) tambin es posible indicarlo en nmero de puntos. En el primer caso se trata de una distancia relativa depende del tamao de la fuente mientras que en el segundo tenemos una distancia absoluta.

10

Elaboracin de documentacin tcnica

Los prrafos se separan aadiendo una fraccin adicional de lnea entre ellos (como mximo una lnea completa). Por ejemplo, en estos apuntes se ha utilizado un espaciado posterior4 de 6 puntos. El texto puede estar alineado a la izquierda (como en este prrafo) o justificado (alineado a derecha e izquierda). Un texto sin justificar da una impresin ms amable e informal, por lo que podemos emplearlo si queremos hacer un informe menos importante. El texto completamente justificado da una impresin de mayor formalidad. Sin embargo, la justificacin no debe emplearse cuando la longitud de las lneas es muy corta porque el procesador se ve forzado a realizar cambios excesivamente pronunciados en el espaciado entre caracteres y entre palabras. El uso de sangra de primera lnea (como lo empleado en este prrafo) es opcional aunque relativamente habitual en la documentacin en espaol. Debe ajustarse entre 0,5 y 1 cm. 6.5. Estilos En cualquier procesador de textos pueden definirse estilos para evitar tener que repetir el proceso cada vez que queremos utilizar un formato determinado. Resulta muy conveniente tener un estilo para: El formato utilizado en el cuerpo del texto (estilo normal). Hay que definir tipo y tamao de letra, interlineado, espaciado entre prrafos, alineacin, sangra Los ttulos y subttulos de los captulos, encabezados, apartados Debe respetarse la jerarqua, utilizando tipologas ms destacadas para los ttulos de primer nivel y reduciendo el tipo de letra a medida que se disminuye el nivel de profundidad. Es muy conveniente emplear numeracin automtica de ttulos; esto resulta trabajoso al principio pero termina reduciendo significativamente el tiempo gastado al realizar una numeracin manual, especialmente cuando el documento es largo. Pies de figura y de tabla. Deben distinguirse del cuerpo del texto para lo cual puede utilizarse cursiva o un tipo o tamao de letra distinto. Es habitual que tengan una alineacin centrada. Notas a pie de pgina. Siempre con tamao de letra menor al del texto. En estos apuntes se ha empleado Times New Roman 10 puntos. Texto dentro de la tabla. Suele ser de un tamao significativamente inferior, lo que facilita la labor de encajar el texto en las celdas.

Terminologa de Microsoft Word.

11

Elaboracin de documentacin tcnica

6.6. Formato de las ilustraciones y tablas Un documento parece mucho ms profesional si todas las ilustraciones de una determinada categora se han preparado con un mismo programa y siguiendo un mismo patrn. Las leyendas de las grficas, por ejemplo, deben ser uniformes y suficientemente grandes para leerse sin dificultad. Debe utilizarse un pie de figura debajo de cada ilustracin, indicando el nmero de orden (el total dentro del documento o el parcial dentro del captulo) y acompaado de un breve texto explicativo. De igual manera las tablas deben ir acompaadas de su correspondiente pie de tabla, aunque en este caso suele situarse encima. La numeracin de figuras y tablas siempre es independiente. Es muy til emplear las herramientas de numeracin automtica disponibles en el procesador de textos. Todas las figuras y tablas deben estar referenciadas en el texto, por lo que no debera existir un elemento al que no se haga referencia en la explicacin. Al citarlas, es preferible indicar el nmero de figura o tabla en lugar de decir en la figura siguiente o en la tabla a continuacin; por ejemplo, la Fig. 1 recoge la estructura de un informe tcnico. En cuanto a la posicin dentro del documento, las ilustraciones y las tablas deben ponerse despus de su referenciacin en el texto, nunca antes de ser citadas. Esto no quiere decir que deban colocarse justo despus del texto correspondiente, ya que esto no siempre es conveniente (por ejemplo, si estamos cerca del final de la pgina e intentamos introducir una figura, sta pasar a la pgina siguiente, quedando un gran hueco vaco). 6.7. Formato de las ecuaciones Es una prctica habitual colocar las ecuaciones en una lnea separada del texto. Deben numerarse para poder hacer referencia a ellas ms adelante, para lo cual suele ponerse el nmero de ecuacin alineado a la derecha. Por ejemplo, la ecuacin (1) calcula el rea de un crculo a partir del dimetro de la circunferencia en m: A = (D/2)2 m2
.

(1)

Los nombres de las variables suelen ponerse en cursiva. Si la formula es parte de una frase, hay que respetar las reglas de ortografa. En el caso de que la ecuacin calcule una magnitud fsica no hay que olvidar indicar las unidades: cm, s, Hz 6.8. Notas a pie de pgina Se ponen notas a pie de pgina cuando la explicacin de una palabra o un dato no encaja bien dentro del texto, p.ej.: la comunicacin multipunto5 proporciona mayor facilidad a la hora de establecer comunicacin, donde 6 aparece al final de la misma pgina (vase all). En el mbito tcnico no se usa este procedimiento para hacer referencias a fuentes externas.

La comunicacin multipunto: La transmisin de datos se realiza desde un cualquier lugar hasta cualquier otro sitio.

12

Elaboracin de documentacin tcnica

6.9. Referencias o Bibliografa Cuando se emplea una idea, resultado, conclusin, figura, datos estadsticos, etc. contenido en otra fuente, se debe informar sobre su procedencia, de manera que el lector pueda consultarla si lo desea. La referenciacin a fuentes externas es muy til para fundamentar el trabajo, ya que permite ahorrar la mayor parte de la explicacin, a la vez que protege de las posibles equivocaciones de esos estudios (el autor del documento no es responsable de las incorrecciones en los resultados publicados por un experto en una publicacin de prestigio). Si bien sera posible, en principio, incluir toda la informacin de la obra original en el momento de citar, el texto se hara difcil de leer por las interrupciones. Por ello, las referencias se resean en una seccin aparte, generalmente al final del texto. Si adems, para la elaboracin del trabajo, se han usado fuentes de informacin que no se citan especialmente (como libros de estudio), esta seccin no se debe llamar Referencias, sino Bibliografa. Si es preciso pueden coexistir en un mismo documento tanto una seccin de Referencias como una de Bibliografa. Hay muchos estilos para la gestin de las referencias a lo largo del documento, pero la mayora de ellos no son usados para trabajos tcnicos (como APA, AMS, Chicago, Harvard etc.). Los ingenieros suelen usar dos estilos tpicos para publicaciones en revistas y congresos, trabajos fin de carrera o tesis doctorales: a) Estilo numerado (IEEE): Dentro del texto se asigna un nmero por orden de aparicin a cada cita. Al final del captulo o del documento se indica la correspondencia entre el nmero y la referencia bibliogrfica de la fuente citada. Cada vez que se vuelve a citar la misma fuente a lo largo del documento se le asigna el mismo nmero. Es el mtodo ms complejo por lo que se hace imprescindible la utilizacin de las herramientas de numeracin automtica de los procesadores de texto. b) Estilo autor-fecha (mezcla entre estilo IEEE y estilos usados en humanidades). Este estilo presenta las citas dentro del texto utilizando el apellido del autor (o una abreviatura del mismo) y la fecha de publicacin (normalmente basta con el ao). Al final del captulo o del documento se indica la referencia bibliogrfica completa, ordenndose las citas por orden alfabtico del apellido del primer autor. Cuando un autor tiene ms de una publicacin en el mismo ao, se aade una letra minscula tras el ao. Tabla 1. Ejemplos de los dos estilos de referenciacin
Texto principal
El modelo de Smith [3] supone una variable aleatoria normal. En cambio, Rayleigh obtuvo mejores resultados considerando un proceso binomial [4]. En cualquier caso en [3] se concluye que los resultados no son extrapolables.

Final del trabajo

[3] A. Smith y C. Wilson, Measurements of multipath in radio wave transmission, IEEE Trans. Antennas and Propagation, vol. 2, 1999, pgs. 23-40. [4] H. Rayleigh, Fundamentals of radio wave propagation, McGraw-Hill, Londres, 2003.

Estilo numerado

El modelo de Smith [Smith 99] supone una [Ray 03] H. Rayleigh, Fundamentals of Estilo radio wave propagation, McGraw-Hill, autor-fecha variable aleatoria normal. En cambio, Rayleigh obtuvo mejores resultados

13

Elaboracin de documentacin tcnica considerando un proceso binomial [Ray 03]. En cualquier caso en [Smith 99] se concluye que los resultados no son extrapolables. Londres, 2003. [Smith 99] A. Smith y C. Wilson, Measurements of multipath in radio wave transmission, IEEE Trans. Antennas and Propagation, vol. 2, 1999, pgs. 23-40.

El formato de la referencia bibliogrfica completa variar en funcin del tipo de fuente utilizada (libro, artculo de revista). Tpicamente se indicar en este orden: autor o autores, nombre de la publicacin o libro, nombre de la revista o de la editorial, captulo o volumen, fecha de publicacin, pginas. Si es posible se tomarn los datos del mismo documento fuente, p.ej. de la portada (si la hubiese). Los datos deben transcribirse tal y como aparecen en la fuente. Otros datos auxiliares, como p.ej. la fecha de consulta de un documento electrnico, debern ir entre corchetes o parntesis. Se indican a continuacin algunos ejemplos: Libros
[1] E.R. Tufte, Visual Explanations: Images and Quantities, Evidence and Narrative, Cheshire, CT, Graphics Press, 1996.

Artculos en compilaciones / captulos en libros

[2] J. W. DuBois, S. Cumming y D. Paolino, Outline of discourse transcription, en Talking Data: Transcription and Coding in Discourse Research (J. A. Edwards and M.D. Lampert, Eds.). Hillsdale, NJ: Lawrence Erlbaum Associates, 1993, pgs. 45-89.

Artculos en revistas
[3] R.C. Carter, Search time with a color display: Analysis of distribution functions, Human Factors, vol. 24, no. 3, 1982, pgs. 302-304.

Artculos en congresos
[4] P. Leone, D.L. Gillihan y T.L. Rauch, Web-based prototyping for user sessions: Mediumfidelity prototyping, Proc. 44th Int. Technical Communications Conference, Toronto, Canada, mayo 1997, pgs. 231-234.

Informes tcnicos
[5] K. Kraiger y M.S. Teachout, Applications of generalizability theory to the Air Force job performance, Human Resources Laboratory, Air Force Systems Command, Brooks Air Force Base, Texas, Tech. Rep. AFHRL-TR-90-92, julio 1991.

Documentos online Se citan este tipo de fuentes si nicamente existen online. Podran ser bases de datos, programas, pginas web, boletines electrnicos, blogs, e-mails, etc. En el caso de ser p.ej. un artculo en formato pdf, se debe citar la revista. 14

Elaboracin de documentacin tcnica

[10] T. Land, Web extension to American Psychological Association style (WEAPAS), [Online] www.nyu.edu/pages/psychology/WEAPAS [Consulta: septiembre 1996]. [13] Parallel Graphics, Cortona SDK, http://www.parallelgraphics.com/products/sdk, [Consulta: 2008-02-29]. [22] Kiwi. "Re: How Do You Cite a Blog Post in your Bibliography?" Kairosnews: A Weblog for Discussing Rhetoric, Technology and Pedagogy. http://kairosnews.org/node/view/1830#comment [entrada del 30 de abril 2003].

15