| Informática y Sociedad | curso 1999-2000 |
Plantilla para la redacción de documentos
| Sergio Barrachina Mir | José Alejandro Pérez | |
| barrachi@uji.es | perezj@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. Este documento proporciona una serie de indicaciones sobre cómo presentar un escrito de este tipo.
Índice
1 Introducción2 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 Cuadros
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 el segundo apartado se tratan las partes o apartados en los que se estructura un escrito. En el tercera apartado, se proporcionan una serie de instrucciones sobre cómo redactar frases, párrafos y encabezados; y sobre cómo utilizar cuadros, figuras, citas y referencias a otros documentos. El cuarto apartado presenta las conclusiones de este documento. El último apartado 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 apartados claramente diferenciados que tienen que ser presentados 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 varios apartados y subapartados), conclusiones y, por último, la lista con las referencias. La finalidad de cada una de estas partes se explica en los siguientes subapartados.
2.1 Título
El título es un texto breve que indica el tema sobre el que versa el documento. Debajo de este se muestran sus autores. 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 sus 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 los apartados y subapartados que forman el documento. En un documento escrito, junto al encabezado de cada apartado aparece la página en el que éste se desarrolla. En un documento de hipertexto (como éste), el número de página (que no tiene sentido) de cada apartado se suele sustituir por un enlace a la página web o parte de la página web en la que se desarrolla el apartado en cuestión.
Si se observa el índice de este documento, se puede ver que sólo aparecen reflejadas los apartados desde la de Introducción hasta la de Referencias y que no aparecen ni el «Resumen», ni el «Í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 su finalidad (qué mejoras presenta respecto a las soluciones existentes), apunta las partes principales en que se divide la investigación, establece los límites del trabajo y la metodología científica empleada.
En cuanto a la numeración de los apartados, el apartado «Introducción» es el primera en ser numerado (ni el «Resumen», ni el «Índice», que aparecen antes que ella poseen numeración; el apartado «Referencias» tampoco se numera).
2.5 Cuerpo del documento
El cuerpo del documento está formado por uno o más apartados en los 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, el último de los apartados forman el cuerpo del documento se dedicará a su exposición (este apartado 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 los apartados 2 y 3, el cuerpo de este documento lo constituyen estos dos apartados.
2.6 Conclusión (o Conclusiones)
Es el último apartado numerado del documento y en este se presentan las opiniones de los autores sobre los temas tratados en el documento. Si el trabajo va a tener continuidad o se prevé que alguien pueda continuarlo, se suelen sugerir en este apartado futuras ampliaciones (cambiando su título a algo como «Conclusiones y trabajo futuro»).
2.7 Referencias
A lo largo del documento es habitual utilizar 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 el Apartado 2.3 para un ejemplo de referencia). Esta etiqueta sirve para que el lector pueda localizar la referencia completa. En el apartado «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 el apartado «Referencias»).
3 Sugerencias para la composición
En este apartado se proporcionan algunas sugerencias para la composición de frases, párrafos y encabezados. Además, también se trata la utilización de cuadros (que no tablas) y de figuras. En cuanto a los cuadros y figuras, se ve cómo se tienen que referenciar en el texto y cómo tienen que titularse.
3.1 Frases y párrafos
Algunas reglas prácticas para la composición de frases y párrafos son las siguientes[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 los apartados y subapartados (así como el propio título del documento) se escriben sin punto final.
3.3 Cuadros
Los cuadros son utilizados para la presentación de aquella información que en el texto se haría difícil de comprender (p.e., «Las prestaciones de un proveedor pueden ser evaluadas (véase Cuadro 1) desde distintos puntos de vista…»).
| PROVEEDOR | Opinión Usuarios | Precio | Velocidad | Total |
|---|---|---|---|---|
| Jet Internet | 88 | 90 | 80 | 86 |
| IdecNet | 89 | 75 | 70 | 81 |
| Intercom | 90 | 40 | 100 | 80 |
| Arrakis | 64 | 90 | 100 | 80 |
| Tinet | 79 | 100 | 50 | 77 |
Como se puede observar en el ejemplo, el título del cuadro y su numeración aparece en su parte superior. La numeración indica el orden de aparición del cuadro dentro del documento.
Como se puede ver en la frase de ejemplo, la forma de referenciar al cuadro ha sido: «veáse Cuadro 1» entre paréntesis.
Si se tiene que citar la fuente de dónde se ha obtenido el cuadro, la cita se hace en la forma mostrada en el pie del Cuadro 1.
Conviene tener en cuenta que la palabra correcta es «cuadro», no «tabla». La palabra «tabla» tiene las siguientes acepciones [RAE23]:
11. f. Lista o catálogo de cosas puestas por orden sucesivo o relacionadas entre sí. La tabla periódica de los elementos químicos.
12. f. Cuadro o catálogo de números de especie determinada, dispuestos en forma adecuada para facilitar los cálculos. Tabla de multiplicar, de logaritmos, astronómica.
3.4 Figuras
Las figuras (ya sean gráficas, ilustraciones o fotos) son identificadas en su pie y pueden ser referenciadas como en el siguiente ejemplo: «El entorno gráfico KDE (véase Figura 1), está reduciendo la barrera entre los sistemas operativos auto-proclamados como fáciles de usar y el sistema operativo GNU/Linux…".
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 |
| [RAE23] | Real Academia Española Diccionario de la lengua española: tabla. https://dle.rae.es/tabla (consultado en 2023) |
| [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 |
http://lorca.act.uji.es/asignatura/e08/html/plantilla.html
|