apuntes documentacion tecnica
TRANSCRIPT
CURSO 2011/12
DOCUMENTACIÓN TÉCNICA
Proyectos (Sonido e Imagen)
Pedro García del Pino
Martina Eckert
Departamento de Ingeniería Audiovisual y Comunicaciones
EUIT Telecomunicación – Universidad Politécnica de Madrid
Elaboración de documentación técnica
1
1 . Introducción
La elaboración de documentación (informes, manuales, procedimientos, propuestas…) es
parte esencial del trabajo del ingeniero. En particular, el informe técnico es una vía de
comunicación de ideas, resultados de estudios o noticias en general. Es el medio de
transmisión y documentación más utilizado y resulta siempre necesario para apoyar
decisiones técnicas o económicas. El informe técnico se puede definir como una “exposición
ordenada y exhaustiva de datos o hechos dirigidos a alguien, sobre un tema determinado o
sobre el estado de una cuestión”. Dicho de otra manera, “un documento que describe el
progreso y resultados de un estudio técnico, una investigación o el estado de un problema”.
Este documento se enfoca en los informes técnicos que, en el ámbito de los proyectos de
ingeniería, son requeridos en muchos momentos de la vida de los mismos, desde la necesidad
de informar a los superiores sobre la evolución de un trabajo hasta la conveniencia de aportar
datos que fundamenten decisiones de tipo técnico. Pero la mayoría de lo expuesto aquí es
válido para otro tipo de documentación técnica (manuales, artículos de investigación,
patentes…), de manera que puede servir como guía de escritura general.
En ámbitos relacionados con actividades de I+D+i, el informe puede ser el modo de hacer
partícipes a otros técnicos o científicos de hallazgos, desarrollos o nuevas ideas e
investigaciones. Un claro ejemplo son los artículos en revistas especializadas y las ponencias
en congresos.
El informe debe ajustarse a ciertas normas formales que aseguren la consecución de sus
objetivos como vía de transmisión de datos y conocimientos. A continuación se repasarán
algunos de estos aspectos.
2 . Cuestiones previas
Antes de empezar a escribir es conveniente preguntarse estas cuestiones:
¿Qué queremos contar? Es decir, cuál será el contenido del informe, lo que queremos
decir y lo que queremos excluir.
¿A quién está dirigido el informe técnico? ¿Debe el lector tomar una decisión a partir
del informe? El informe siempre está dirigido a una persona o a un equipo de personas,
por lo que su redacción 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.
¿Cuál es el propósito del informe técnico? Por ejemplo, informar a nuestro jefe sobre el
estado del proyecto, solicitar recursos adicionales, persuadir a un cliente sobre las
ventajas de nuestro diseño, analizar diferentes alternativas… El enfoque del documento,
aún tratándose de los mismos datos, será distinto en función del objetivo que
perseguimos con la redacción del mismo.
¿Cuál es la estructura más adecuada para el documento?, ¿cuál debería ser la extensión
máxima del informe?
Aunque existen múltiples maneras de abordar la redacción de un informe, todos deberían
regirse por unos principios básicos:
Elaboración de documentación técnica
2
Utilización 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, márgenes…) como el estilo. El aumento forzado de la extensión no
beneficia a la calidad del informe.
Objetividad. Los trabajos de ingeniería, 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 dirección.
Aún así, es una obligación del ingeniero evitar la parcialidad, sin dejarse influir por las
circunstancias.
Argumentación detallada, fundamentada y rigurosa. El discurso del informe debe
seguir un razonamiento minucioso. Cuando se mencionen bondades o faltas, es justo
fundamentarlas en argumentos sólidos. 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 perfección 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
introducción es la tarea más 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 más directa; por ejemplo, metodología, procedimientos… en ellas no hay
interpretación.
En cuanto a la extensión, un informe corto es mejor que uno largo si consigue transmitir la
misma información. Si podemos decir lo mismo en 2000 palabras que en 5000, con seguridad
es mejor utilizar 2000. Eliminar cosas redundantes e innecesarias.
3 . El título del informe
La elección del título del informe técnico es una cuestión de primera magnitud. El título
genera en el lector ciertas expectativas que será necesario satisfacer. Además, puede dar el
tono general del escrito.
Un buen título debe tener las siguientes características:
Comprensible. Entenderse con facilidad y servir de introducción al contenido del
trabajo.
Claro. Evitar títulos imprecisos, desorientadores, excesivamente recargados o
extravagantes. Huir de la vaguedad, de la generalización. Asegurarnos que refleja el
contenido.
Elaboración de documentación técnica
3
Descriptivo a la vez que conciso. Debe describir con la mayor exactitud posible el
contenido del informe pero sin que la extensión sea excesiva. Si, aún así, el título resulta
demasiado complejo puede recurrirse a la utilización de un subtítulo; esto no siempre es
posible cuando el informe debe cumplir una serie de requisitos formales.
En el orden lingüístico se aconseja el predominio de los sustantivos, utilizando los adjetivos,
frases hechas o locuciones adverbiales sólo en el caso de que se hagan imprescindibles.
En la medida de lo posible evitar que el título comience con expresiones del tipo: “un estudio
de…”, “un experimento sobre…”, “análisis de…”, etc.
Como recomendación práctica es conveniente probar diversas formulaciones; no siempre el
primer título escogido es el definitivo sino que, a menudo, se retoca a lo largo de la
generación 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 típica de un informe técnico
4.1. Portada
La primera hoja o portada del informe técnico deberá contener el título (y subtítulo) del
proyecto, el nombre o nombres completos de los autores (incluyendo si es preciso su
titulación, procedencia y dirección de contacto) y la fecha de elaboración. En algunos casos
será necesario incluir un número de referencia. También es habitual que figure el logotipo de
la empresa o institución a la que pertenece el autor.
Elaboración de documentación técnica
4
4.2. Resumen ejecutivo
Todo informe técnico debe contener un resumen que se presentará inmediatamente después de
la información 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 básicas a tener en cuenta en la redacción del resumen ejecutivo son:
Debe definir el objetivo, describir el método empleado y resumir las conclusiones.
Constituye un texto completo e independiente, no es una parte de un documento más
amplio. En el cuerpo del informe no puede hacerse referencia al resumen.
Debe proporcionar una visión completa, de modo que los lectores puedan decidir si
están interesados o no en leer cada sección del informe.
Debe escribirse con frases completas (no lenguaje esquemático).
No incluye figuras, tablas ni fórmulas, salvo que sea completamente imprescindible.
Los términos poco comunes, las abreviaturas y los símbolos deben definirse en la
primera aparición.
En el caso de una publicación científica este apartado se sustituiría por un resumen (abstract).
Lo expuesto de aquí en adelante es válido para todo tipo de redacciones científicas.
4.3. Tabla de contenido. Lista de figuras y tablas
Se debe realizar una tabla de contenido si el tamaño del documento es amplio, dividiéndolo y
clasificándolo lo más posible. Debe constar de los títulos de las principales subdivisiones del
informe y los anexos, junto con el número de páginas en las que aparecen. Suele adoptarse la
numeración decimal como criterio universal de clasificación. El índice ha de ser un reflejo
exacto del contenido del trabajo, aunque su extensión dependerá de si se consignan todos los
aspectos o sólo los más representativos.
En informes de cierta envergadura es habitual añadir un listado de las figuras y tablas, de
manera que los lectores puedan localizarlas rápidamente. No siempre hay que incluir el título
completo de la figura o la tabla, puede abreviarse.
Cuando el informe contenga signos, símbolos, unidades, abreviaturas, acrónimos o términos
técnicos que puedan no ser comprendidos por los posibles lectores, es una buena práctica
definirlos en un glosario. Aún así, no debe omitirse la explicación de estos símbolos 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 más compleja, ya que en
ella se da a conocer el contenido del estudio. Su estructura y presentación deben facilitar la
lectura del documento y contribuir a transmitir su mensaje al destinatario. Para que el lector
aprecie cierta consistencia lógica, será muy útil distribuir el texto en capítulos o secciones.
Una vez realizado lo anterior debemos asegurarnos de que cada división tiene sentido por sí
misma y a la vez mantiene cierta unidad global con el resto de capítulos.
Una posible estructura de la exposición es la siguiente:
Elaboración de documentación técnica
5
Introducción. Anunciar y presenta el tema para ganar la atención del lector. Establece
brevemente el alcance y objetivos del trabajo, su relación con otros trabajos y el
enfoque general. Ha de ser breve y clara, no debe repetir o parafrasear el resumen, ni
dar detalles técnicos sobre la teoría, métodos o resultados. De ningún modo puede
anticipar las conclusiones.
Desarrollo (núcleo del informe). Debe dividirse en capítulos numerados que cubran
aspectos tales como: bases teóricas, métodos y procedimientos, resultados y discusión.
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 matemáticas, etc. deben presentarse en los anexos.
Una división típica en un informe de cierta envergadura es la siguiente:
o Antecedentes. Planteamiento del problema.
o Fundamentos teóricos.
o Métodos y procedimientos empleados.
o Resultados y discusión 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 acción 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 interés, 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 técnica, con el objetivo de aportar conocimientos u opiniones sobre
una cuestión abierta. En tal caso conviene no ser demasiado categórico en afirmaciones
discutibles.
Al final del cuerpo del informe pueden incluirse agradecimientos relativos a ayudas en la
realización del trabajo y en la preparación del informe.
4.5. Referencias
Siempre que se cita o se utiliza información de otras fuentes debe indicarse su procedencia.
Lo más habitual es incluir todas las fuentes en una lista al final del informe. En el apartado 6.8
se explicarán las formas más habituales empleadas en documentación técnica para escribir las
referencias.
Elaboración de documentación técnica
6
4.6. Anexos
Como anexos al informe se incluirán los cálculos 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 exposición. Algunos ejemplos son:
Material que, insertado en el cuerpo del informe, alteraría la presentación ordenada y
lógica del trabajo.
Material especial que no puede ser colocado adecuadamente en el cuerpo del informe a
causa de su tamaño o del método de reproducción utilizado: mapas, fotografías
originales…
Información demasiado técnica 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
comprensión inmediata del texto, pero que proporcionan ejemplos complementarios.
Descripción de equipos, técnicas o programas de ordenador utilizados en el estudio.
Los anexos se indexan típicamente por letras mayúsculas (Anexo A, Anexo B…) y deben
considerarse como entidades independientes, por lo que deben dividirse separadamente en
capítulos, apartados… y las ilustraciones, tablas, referencias y ecuaciones deben numerarse de
nuevo con cada anexo.
5 . El estilo narrativo
Un documento técnico consta de componentes: texto (palabras, que se agrupan en frases,
párrafos y apartados), elementos gráficos (gráficas, esquemas, fotografías) y datos
(ecuaciones, tablas). Todos ellos colaboran en la transmisión de la información.
Se comentan a continuación algunas técnicas estilísticas simples relacionadas con estos
componentes que ayudan a expresar las ideas de forma clara.
5.1. Las palabras
Emplear palabras sencillas, más fácilmente entendibles por el lector. La utilización de
palabras rebuscadas puede generar una distorsión 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 paráfrasis (mejor controlar que hacer un control).
Es preferible utilizar términos técnicos en castellano a cualquier término extranjero o
cultismo, pero siempre que exista una traducción adecuada y aceptada de forma general y no
sea un neologismo.
En documentos que serán leídos 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 más cercano al habitual, en el que los términos
empleados se expliquen con precisión, 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
Elaboración de documentación técnica
7
contraproducentes; sólo es aconsejable su utilización cuando se pueden relacionar
directamente con la realidad o son muy verosímiles.
5.2. Las frases
En la redacción de documentación técnica las frases deben escribirse con naturalidad y
siguiendo el orden lógico de sujeto + verbo + complementos. La alternancia de distintos tipos
de frases – cortas, largas, enunciativas, expositivas – da ritmo y hace más fluida la lectura,
evitando la monotonía.
Evitar frases excesivamente largas. La excesiva longitud aumenta las posibilidades de que la
oración 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 mío 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 sólo autor, se usan los pronombres
nosotros o nuestros.
5.3. Los párrafos
La división del escrito en párrafos ayuda al lector a seguir el argumento, facilitando la
comprensión del documento mediante la secuenciación de su contenido. Si un texto es muy
largo y no se divide en párrafos la lectura resulta fatigosa y monótona. Además, la división
hace más atractiva la visualización de la página.
Cada párrafo debe conducir de manera natural al siguiente, de lo contrario el lector puede
verse dentro de una maraña de información mal estructurada. Cuando exista una falta de
relación entre párrafos es aconsejable incluir un párrafo de transición que resuma las ideas
más importantes del anterior y le dé paso al siguiente. Estos párrafos robustecen el texto y dan
impresión de orden y coherencia.
5.4. La división en apartados, capítulos o secciones
Una buena estructura se caracteriza también por la utilización de títulos y subtítulos, lo cual
proporciona una adecuada visión global de un solo vistazo.
Los títulos intermedios deben ser:
Explícitos. Deben permitir conocer de un vistazo el tema del texto que viene a
continuación.
Breves. Más de una línea es siempre excesivo.
Comprensivos.
Ordenados lógicamente. Criterio determinado y uniforme.
5.5. Las ilustraciones
Las fotografías o las ilustraciones – mapas, gráficos, planos, dibujos, esquemas, etc. – son
mensajes visuales que suelen resumir la información de forma clara y rápida y, por
Elaboración de documentación técnica
8
consiguiente, se utilizan para sintetizar una larga explicación. Aportan al escrito claridad y
atractivo, consiguiendo reforzar la comunicación.
5.6. Siglas y acrónimos
Las siglas y acrónimos deben definirse la primera vez que se utilicen, añadiendo la
traducción si están en inglés. Hay dos maneras posibles de introducir las abreviaturas, si bien
en el documento se debe utilizar una única:
abreviatura con la explicación en paréntesis, p.ej.:
o La FPGA (Field Programmable Gate Array) de la firma XYZ
o Los diseñadores de ASICs (Application Specific Integrated Circuits o
Circuitos Integrados para Aplicaciones Específicas) 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 paréntesis, p.ej.:
o “…obtenida mediante la asistencia a las III Jornadas Internacionales de la
Universidad Politécnica de Madrid (UPM) sobre Innovación Educativa y
Convergencia Europea (INECE)”
Explicaciones más amplias se pueden poner como nota al pie de página.
6 . Cuestiones formales
Un escrito técnico debe reunir una serie de características que lo hagan atractivo a la
audiencia a la vez que mantiene su carácter funcional. El aspecto visual de cualquier trabajo
es muy importante: un trabajo mal presentado influye negativamente, mientras que una buena
presentación crea una expectativa favorable.
En este apartado se tratarán algunas cuestiones relacionadas con la presentación de los
escritos técnicos, indicando algunas precauciones y recomendaciones que deben seguirse para
lograr que el documento sea leído y comprendido sin dificultad por los lectores.
6.1. Numeración de párrafos, epígrafes, títulos y páginas
La numeración, dentro de un escrito técnico, facilita cualquier referencia posterior al
contenido, bien sea en una exposición oral posterior o a lo largo del propio documento.
El sistema más utilizado en documentación técnica es la numeración decimal, pudiendo
emplearse en capítulos, títulos, subtítulos, párrafos y hasta líneas. Un uso excesivo sería
cansado para al lector y pierde su eficacia cuando la referencia se torna excesivamente
compleja. No es habitual ni recomendable emplear más de 3 ó 4 niveles de profundidad para
los títulos.
1 VHDL es el acrónimo que representa la combinación de VHSIC y HDL, siendo VHSIC el acrónimo de Very
High Speed Integrated Circuit y HDL.
Elaboración de documentación técnica
9
En la numeración alfanumérica los distintos epígrafes se enumeran mediante un número y
los subepígrafes mediante una letra del alfabeto en el orden que éste determina. Funciona bien
sólo en documentos simples.
Las páginas del escrito pueden numerarse de modo continuo, desde la primera hasta la
última página del documento, o mixto, empleando tanto el número de capítulo como el
número de orden de la página dentro de ese capítulo. Puede omitirse la numeración de
portadas, contraportadas y el índice si sólo consta de una hoja.
6.2. Formato de la página
En la configuración de página de un editor de textos debe especificarse el tamaño de papel, su
orientación y los márgenes. También puede definirse un encabezado y pie de página.
En Europa suele emplearse papel tamaño A4, orientación vertical y una única columna para
toda la página. Es necesario indicar si la impresión se realizará a doble cara ya que, en ese
caso, habrá que definir formatos distintos para páginas pares e impares.
Algunos valores típicos de márgenes de página son:
Superior e inferior: 2,5 cm.
Derecho: 2 cm.
Izquierdo: 3 cm (puede ser algo mayor dependiendo del tipo de encuadernación).
En la impresión a doble cara los márgenes se denominan interior y exterior. Sus medidas
serán equivalentes a los márgenes izquierdo y derecho, respectivamente.
Es recomendable el uso de encabezados y pies de página, pues dan al documento un mejor
aspecto visual. Además, los encabezados pueden incluir información sobre el número y
nombre de capítulo 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 páginas pares e impares. Por ejemplo, el
encabezado de las páginas pares puede ser el título del escrito, mientras que en las
páginas impares puede ponerse el título del apartado o capítulo.
El número de página puede ponerse tanto en el encabezado o en el pie de página pero en
ambos casos en la parte exterior.
Tanto en los encabezados como en los pies de página se empleará un tipo de letra distinto al
del resto del texto. Adicionalmente, es muy habitual introducir una línea de separación
(obsérvese, por ejemplo, el formato utilizado en estos apuntes).
6.3. Tipo y tamaño 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
propósitos artísticos. Hay que procurar emplear un tipo de letra que sea atractivo al lector y no
dificulte su lectura. No es aconsejable utilizar más de dos tipos de letra diferentes.
Elaboración de documentación técnica
10
Son más fáciles de leer las letras en minúsculas que las mayúsculas. Los tipos de letra con
serifa2 (Times Roman o Cambria) se leen mejor que las que van sin serifa (Arial o Calibri).
También se leen con dificultad las letras que imitan la caligrafía (Lucida Handwriting) y
las decorativas (French Script). Las cursivas también dificultan la lectura cuando se emplean
de manera excesiva: son útiles para resaltar un término extranjero, títulos de libros o artículos
y en metalenguaje. LOS TEXTOS LARGOS, ESCRITOS TOTALMENTE EN
MAYÚSCULAS, SON MÁS DIFÍCILES DE LEER Y DE INTERPRETAR.
El estilo negrita puede emplearse para enfatizar o, con discreción, para seleccionar las
palabras clave en un párrafo. Cuando se quiere remarcar algo, siempre es preferible utilizar
negrita en lugar de subrayado, que ha quedado obsoleto y recuerda más bien a las antiguas
máquinas de escribir. Tampoco se usan “comillas” (están reservadas para citas literarias).
Si es necesario emplear palabras extranjeras, por ausencia de equivalente en castellano,
pueden señalarse poniéndolas en cursiva. No utilizar innecesariamente barbarismos que tienen
sustituto.
La distancia entre las letras y entre las palabras también 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" minúscula de este mismo tipo y tamaño.
En cuanto al tamaño 12 puntos es adecuado para escritura en línea continua y 11 puntos para
escribir a dos columnas. Hay que advertir que dos fuentes distintas pueden tener tamaños
reales diferentes aunque especifiquemos el mismo número de puntos (compárese, por
ejemplo, Arial 12 puntos y Times New Roman 12 puntos).
El color (un segundo color además del negro) debería utilizarse con moderación en un
documento técnico ya que la impresión de un documento que contiene fuentes en color es más
cara y lenta. En muchas ocasiones habrá restricciones externas que lo impidan. A cambio, el
color puede captar la atención del lector con más facilidad, permitiendo remarcar aquellos
aspectos que son más importantes. Es especialmente útil en los encabezados, para destacar
términos especiales y en la edición de notas al margen.
6.4. Formato de los párrafos
Para establecer la distancia entre líneas 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%.
2 Serifa o serif. Las tipografías con serifa (serif) son las que llevan remate en los extremos. Las tipografías sin
serifa (sans serif – del francés sans “sin”), también llamadas de palo seco, se caracterizan por la ausencia de
remates.
3 Aunque en los procesadores de texto es más habitual que el interlineado se exprese en número de líneas (1
línea: sencillo, 2 líneas: doble…) también es posible indicarlo en número de puntos. En el primer caso se trata de
una distancia relativa – depende del tamaño de la fuente – mientras que en el segundo tenemos una distancia
absoluta.
Elaboración de documentación técnica
11
Los párrafos se separan añadiendo una fracción adicional de línea entre ellos (como máximo
una línea 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 párrafo) o justificado (alineado a
derecha e izquierda). Un texto sin justificar da una impresión más amable e informal, por lo
que podemos emplearlo si queremos hacer un informe menos importante. El texto
completamente justificado da una impresión de mayor formalidad.
Sin embargo, la justificación no debe
emplearse cuando la longitud de las líneas 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 sangría de primera línea (como lo empleado en este párrafo) es opcional
aunque relativamente habitual en la documentación en español. 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
tamaño de letra, interlineado, espaciado entre párrafos, alineación, sangría…
Los títulos y subtítulos de los capítulos, encabezados, apartados… Debe respetarse la
jerarquía, utilizando tipologías más destacadas para los títulos de primer nivel y
reduciendo el tipo de letra a medida que se disminuye el nivel de profundidad. Es muy
conveniente emplear numeración automática de títulos; esto resulta trabajoso al
principio pero termina reduciendo significativamente el tiempo gastado al realizar una
numeración 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 tamaño de letra distinto. Es habitual que tengan una
alineación centrada.
Notas a pie de página. Siempre con tamaño 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 tamaño significativamente inferior, lo que
facilita la labor de encajar el texto en las celdas.
4 Terminología de Microsoft Word.
Elaboración de documentación técnica
12
6.6. Formato de las ilustraciones y tablas
Un documento parece mucho más profesional si todas las ilustraciones de una determinada
categoría se han preparado con un mismo programa y siguiendo un mismo patrón. Las
leyendas de las gráficas, por ejemplo, deben ser uniformes y suficientemente grandes para
leerse sin dificultad.
Debe utilizarse un pie de figura debajo de cada ilustración, indicando el número de orden (el
total dentro del documento o el parcial dentro del capítulo) y acompañado de un breve texto
explicativo. De igual manera las tablas deben ir acompañadas de su correspondiente pie de
tabla, aunque en este caso suele situarse encima. La numeración de figuras y tablas siempre
es independiente. Es muy útil emplear las herramientas de numeración automática disponibles
en el procesador de textos.
Todas las figuras y tablas deben estar referenciadas en el texto, por lo que no debería existir
un elemento al que no se haga referencia en la explicación. Al citarlas, es preferible indicar el
número de figura o tabla en lugar de decir “en la figura siguiente” o “en la tabla a
continuación”; por ejemplo, “la Fig. 1 recoge la estructura de un informe técnico”.
En cuanto a la posición dentro del documento, las ilustraciones y las tablas deben ponerse
después de su referenciación en el texto, nunca antes de ser citadas. Esto no quiere decir que
deban colocarse justo después del texto correspondiente, ya que esto no siempre es
conveniente (por ejemplo, si estamos cerca del final de la página e intentamos introducir una
figura, ésta pasará a la página siguiente, quedando un gran hueco vacío).
6.7. Formato de las ecuaciones
Es una práctica habitual colocar las ecuaciones en una línea separada del texto. Deben
numerarse para poder hacer referencia a ellas más adelante, para lo cual suele ponerse el
número de ecuación alineado a la derecha. Por ejemplo, “la ecuación (1) calcula el área de un
círculo a partir del diámetro de la circunferencia en m:”
A = π (D/2)2 m
2 .
(1)
Los nombres de las variables suelen ponerse en cursiva. Si la formula es parte de una frase,
hay que respetar las reglas de ortografía.
En el caso de que la ecuación calcule una magnitud física no hay que olvidar indicar las
unidades: cm, s, Hz…
6.8. Notas a pie de página
Se ponen notas a pie de página cuando la explicación de una palabra o un dato no encaja
bien dentro del texto, p.ej.: “…la comunicación multipunto5 proporciona mayor facilidad a la
hora de establecer comunicación…”, donde 6 aparece al final de la misma página (véase allí).
En el ámbito técnico no se usa este procedimiento para hacer referencias a fuentes externas.
5La comunicación multipunto: La transmisión de datos se realiza desde un cualquier lugar hasta cualquier otro
sitio.
Elaboración de documentación técnica
13
6.9. Referencias o Bibliografía
Cuando se emplea una idea, resultado, conclusión, figura, datos estadísticos, etc. contenido en
otra fuente, se debe informar sobre su procedencia, de manera que el lector pueda consultarla
si lo desea. La referenciación a fuentes externas es muy útil para fundamentar el trabajo, ya
que permite ahorrar la mayor parte de la explicación, 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 publicación de prestigio).
Si bien sería posible, en principio, incluir toda la información de la obra original en el
momento de citar, el texto se haría difícil de leer por las interrupciones. Por ello, las
referencias se reseñan en una sección aparte, generalmente al final del texto.
Si además, para la elaboración del trabajo, se han usado fuentes de información que no se
citan especialmente (como libros de estudio), esta sección no se debe llamar “Referencias”,
sino “Bibliografía”. Si es preciso pueden coexistir en un mismo documento tanto una sección
de Referencias como una de Bibliografía.
Hay muchos estilos para la gestión de las referencias a lo largo del documento, pero la
mayoría de ellos no son usados para trabajos técnicos (como APA, AMS, Chicago, Harvard
etc.). Los ingenieros suelen usar dos estilos típicos para publicaciones en revistas y congresos,
trabajos fin de carrera o tesis doctorales:
a) Estilo numerado (IEEE): Dentro del texto se asigna un número por orden de aparición
a cada cita. Al final del capítulo o del documento se indica la correspondencia entre el
número y la referencia bibliográfica de la fuente citada. Cada vez que se vuelve a citar
la misma fuente a lo largo del documento se le asigna el mismo número. Es el método
más complejo por lo que se hace imprescindible la utilización de las herramientas de
numeración automática 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 publicación (normalmente basta con el año). Al
final del capítulo o del documento se indica la referencia bibliográfica completa,
ordenándose las citas por orden alfabético del apellido del primer autor. Cuando un
autor tiene más de una publicación en el mismo año, se añade una letra minúscula tras el
año.
Tabla 1. Ejemplos de los dos estilos de referenciación
Texto principal Final del trabajo
Estilo
numerado
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.
[3] A. Smith y C. Wilson, “Measurements of multipath in radio wave transmission”, IEEE Trans. Antennas and Propagation, vol. 2, 1999, págs. 23-40.
[4] H. Rayleigh, “Fundamentals of radio wave propagation”, McGraw-Hill, Londres, 2003.
Estilo
autor-fecha
El modelo de Smith [Smith 99] supone una variable aleatoria normal. En cambio, Rayleigh obtuvo mejores resultados
[Ray 03] H. Rayleigh, “Fundamentals of radio wave propagation”, McGraw-Hill,
Elaboración de documentación técnica
14
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, págs. 23-40.
El formato de la referencia bibliográfica completa variará en función del tipo de fuente
utilizada (libro, artículo de revista…). Típicamente se indicará en este orden: autor o autores,
nombre de la publicación o libro, nombre de la revista o de la editorial, capítulo o volumen,
fecha de publicación, páginas. Si es posible se tomarán 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 electrónico,
deberán ir entre corchetes o paréntesis.
Se indican a continuación algunos ejemplos:
Libros
[1] E.R. Tufte, Visual Explanations: Images and Quantities, Evidence and Narrative, Cheshire, CT,
Graphics Press, 1996.
Artículos en compilaciones / capítulos 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, págs. 45-89.
Artículos en revistas
[3] R.C. Carter, “Search time with a color display: Analysis of distribution functions”, Human
Factors, vol. 24, no. 3, 1982, págs. 302-304.
Artículos en congresos
[4] P. Leone, D.L. Gillihan y T.L. Rauch, “Web-based prototyping for user sessions: Medium-
fidelity prototyping”, Proc. 44th Int. Technical Communications Conference, Toronto, Canada,
mayo 1997, págs. 231-234.
Informes técnicos
[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. Podrían ser bases de datos,
programas, páginas web, boletines electrónicos, blogs, e-mails, etc. En el caso de ser p.ej. un
artículo en formato pdf, se debe citar la revista.
Elaboración de documentación técnica
15
[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].