Informática y Sociedad curso 1999-2000

Plantilla para la redacción de documentos

Sergio Barrachina Mir    José Alejandro Pérez
barrachi@inf.uji.es    perezj@si.uji.es

Resumen

Este documento es una plantilla para la presentación de los trabajos de la asignatura Informática y Sociedad y su estructura es la de un artículo de carácter científico-técnico. En el mismo se proporcionan una serie de indicaciones sobre cómo presentar un escrito de este tipo.

Índice

1 Introducción
2 Estructura de un documento científico-técnico
   2.1 Título
   2.2 Resumen
   2.3 Índice
   2.4 Introducción
   2.5 Cuerpo del documento
   2.6 Conclusión (o Conclusiones)
   2.7 Referencias
3 Sugerencias para la composición
   3.1 Frases y párrafos
   3.2 Encabezados
   3.3 Tablas
   3.4 Figuras
4 Conclusiones
Referencias

1 Introducción

Entre los objetivos de la asignatura Informática y Sociedad está el de orientar al estudiante en la correcta preparación de escritos de carácter científico-técnico. Para poder aplicar estos conocimientos, el estudiante puede optar por la presentación de un trabajo para superar la asignatura. El tema del trabajo a presentar puede estar directamente relacionado con el temario de la asignatura (historia de la informática [Williams97] o de los microprocesadores [Malone94]) o con aspectos relacionados con la informática en la actualidad.

Este documento debe ser considerado como una guía sobre los distintos aspectos a tener en cuenta en la redacción de un documento científico-técnico y muestra mediante ejemplos cómo escribir un trabajo de estas características.

El resto del documento está estructurado como sigue. En la segunda sección se tratan las partes o secciones en las que se estructura un escrito. En la tercera sección, se proporcionan una serie de instrucciones sobre cómo redactar frases, párrafos y encabezados; y sobre cómo utilizar tablas, figuras, citas y referencias a otros documentos. La cuarta sección presenta las conclusiones de este documento. La última sección corresponde a las referencias bibliográficas utilizadas a lo largo del documento.

2 Estructura de un documento científico-técnico

Los documentos científico-técnicos se estructuran en una serie de partes o secciones claramente diferenciadas que han de ser presentadas en un determinado orden.

Consultando este documento se pueden localizar estas partes. Éstas son: título (con información sobre los autores), resumen, índice, cuerpo del documento (formado por varias secciones y subsecciones), conclusiones y por último la lista de referencias. La finalidad de cada una de estas partes se explica en las siguientes subsecciones.

2.1 Título

El título es un texto breve que indica el tema sobre el que versa el documento. Debajo del mismo se ponen los autores del mismo. El título de este documento es "Plantilla para la redacción de documentos" y como información sobre los autores aparecen sus nombres y direcciones de correo electrónico.

2.2 Resumen

El resumen permite al lector tener una idea del contenido del documento antes de su lectura. Se trata, por tanto, de una descripción breve del contenido del documento. Véase como ejemplo el resumen de este documento.

2.3 Índice

En el índice se presentan de forma ordenada los encabezados de las secciones y subsecciones que forman el documento. En un documento escrito, junto al encabezado de cada sección aparece la página en la que ésta se desarrolla. En un documento hipertexto (como éste), el número de página (que no tiene sentido) de cada sección se suele sustituir por un enlace a la página web o parte de la página web en la que ésta se desarrolla. Si se observa el índice de este documento, se puede ver que sólo aparecen reflejadas las secciones desde la de Introducción hasta la de Referencias y no así ni el Resumen ni el propio Índice, que es como debe hacerse.

2.4 Introducción

En la introducción [SMG97]:

El investigador justifica la necesidad de la investigación, señala la finalidad de ésta, apunta las partes principales en que se divide, establece los límites del trabajo y la metodología científica empleada.

En cuanto a la numeración de las secciones, la Introducción es la primera en ser numerada (ni el Resumen ni el Índice que aparecen antes que ella poseen numeración; la Sección Referencias tampoco se numera).

2.5 Cuerpo del documento

El cuerpo del documento está formado por una o más secciones en las que se desarrolla el tema del documento. Si el documento explica un trabajo en el que se ha llevado a cabo algún tipo de experimentación, la ultima de las secciones que forman el cuerpo del documento se dedica a la exposición de estos (esta sección se suele titular "Experimentos y resultados")

Puesto que el tema de este documento es el cómo redactar documentos y que, como se puede observar, este tema está realmente desarrollado en las secciones 2 y 3, el cuerpo de este documento lo constituyen estas dos secciones.

2.6 Conclusión (o Conclusiones)

Es la última sección numerada del documento y en ella se presentan las opiniones de los autores sobre los temas tratados en el documento. Si el trabajo ha de tener continuidad o se preve que alguien pueda continuarlo, se suelen sugerir en este apartado futuras ampliaciones del mismo.

2.7 Referencias

A lo largo del documento es habitual haber utilizado información obtenida de diversas fuentes. Cuando se utiliza información de este tipo, se indica en el texto mediante una etiqueta entre corchetes (véase la Sección 2.3 para un ejemplo de referencia). Esta etiqueta sirve para localizar la referencia completa. En la sección Referencias (que aparece al final del documento) se proporciona un lista con las etiquetas utilizadas a lo largo del documento y la información sobre las obras a las que éstas se refieren.

Las etiquetas se ordenan alfabéticamente para permitir la rápida localización del documento referenciado (véase la Sección Referencias).

3 Sugerencias para la composición

En esta sección se proporcionan algunas sugerencias para la composición de frases, párrafos y encabezados. Además, también se trata la utilización de tablas y de figuras. En cuanto a las tablas y figuras, se ve cómo se han de referenciar en el texto y cómo han de ser tituladas correctamente.

3.1 Frases y párrafos

Algunas reglas prácticas para la composición de frases y párrafos son [SMG97]:

Las frases deben ser cortas. Una regla de oro es: SUJETO, VERBO Y COMPLEMENTOS. Y después, punto. Una regla para obtener claridad es poner punto después de cada frase concluida.

Los párrafos también deben de ser breves. Cuatro o cinco oraciones son suficientes. Y, después, punto y aparte.

Hay que evitar los errores de construcción: concordancia, uso de preposiciones (género, número, modos verbales), tiempos de verbos, ...

3.2 Encabezados

Los encabezados de las secciones y subsecciones (así como el propio título del documento) se escriben sin punto final.

3.3 Tablas

Las tablas son utilizadas para la presentación de aquella información que en el texto se haría difícil de comprender (e.g. "Las prestaciones de un proveedor pueden ser evaluadas (ver Tabla 1) desde distintos puntos de vista ...")

Tabla 1: Los 5 mejores proveedores de Internet (Enero 1998).
PROVEEDOR Opinión Usuarios Precio Velocidad Total
Jet Internet
Proveedor del mes
88 90 80 86
IdecNet 89 75 70 81
Intercom 90 40 100 80
Arrakis 64 90 100 80
Tinet 79 100 50 77
Fuente: "Dios Proveerá" http://www.areas.net/dp/

Como se puede observar en el ejemplo, el título de la tabla y su numeración aparece en la parte superior de la misma. La numeración indica el orden de aparición de la tabla dentro del documento. La referencia a la tabla utilizada en la frase de ejemplo es: "ver Tabla 1" entre paréntesis.

Si se ha de citar la fuente de dónde se ha obtenido la tabla, la cita se hace en la forma mostrada en el pie de la Tabla 1.

3.4 Figuras

Las figuras (ya sean gráficas, ilustraciones o fotos) son identificadas al pie de la misma y pueden ser referenciadas como en el siguiente ejemplo: "El entorno gráfico KDE (ver Figura 1), está reduciendo la barrera entre los sistemas operativos auto-proclamados como fáciles de usar y el sistema operativo Linux ...".


Figura 1: El entorno gráfico KDE.

4. Conclusiones

Este documento pretende servir de ejemplo de una buena presentación de un escrito científico-técnico. No trata todos los puntos que intervienen en la elaboración de un buen escrito pero sí aquellos que los autores han considerados más relevantes. Cualquier sugerencia sobre el contenido o composición del mismo será bienvenida.

Referencias

[Malone94] Michael S. Malone (1994). The microprocessor. A biography. TELOS, Santa Clara, California. TK7895.M5 M35 1994
[SMG97] Miguel Ángel Santos Guerra, Benjamín Mantecón Ramírez y Cristóbal González Álvarez (1997). Libro de estilo para universitarios. Miguel Gómez Ediciones. 2a Edición.
[Williams97] Michael R. Williams (1997). A history of computing technology. IEEE Computer Society Press cop. QA76.17 .W55 1997

E08

http://lorca.act.uji.es/e08/html/plantilla.html