Redactar

Algunos consejos básicos, en general de formato, para la redacción de un documento.

Plantilla para LaTeX

Para aquellos que decidan hacer la memoria del TFG (Trabajo de Fin de Grado) en LaTeX, se proporciona a continuación una plantilla completa. (tutorial: LaTeX para TFG en Ubuntu). Para UC3M: Mucha documentación en Campus Global, y en UC3M/Biblioteca (incluida matriz calificación).

• Plantilla TFG LaTeX

• Plantilla Master LaTeX

Índice

• Una profundidad de índice admisible es hasta 3 subniveles (sección 2.3.4), aunque luego en el documento se desglosen más (sección 2.3.4.c).
• Cantidad de páginas por capítulo compensado (no tiene sentido que un capítulo sea de 80 páginas y otro de 3).

Texto (Contenido)

• Introducción, Estado del arte (de partes A/B/...), Arquitectura global, Desarrollo parte A, Desarrollo parte B/..., Experimentos y resultados, Conclusiones y líneas futuras. Bibliografía. Apéndices/Anexos (sí: presupuesto)(posible: partes relevantes de datasheets)(no códigos fuentes completos, mejor proporcionar URL en documento).
• El estado del arte de un documento científico debería consistir en referencias a documentos científicos que componen la bibliografía, tanto por que sean útiles o porque posteriormente se debata que se hayan superado. También debería servir para explicar alternativas software o hardware, como apoyo para justificar decisiones de diseño que se tomen más adelante en el documento (en un capítulo de Arquitectura global).

Texto (Formato)

• Justificado (no alineado a izquierda).
• Sin faltas de ortografía ni gramática.
• Sin faltas en la puntuación: espacio después de punto, etc. Cuidado en mayúsculas/minúsculas.
• Evitar la reutilización de frases completas de otros documentos (copia+pega). Incluso las licencias más abiertas piden que se cite la fuente original.
• Frases cortas. Como regla general, se puede pensar "no más de un concepto por frase, tal vez más de una frase para explicar un solo concepto".
• Coherencia interna. Ejemplo 1: MTi debe aparecer siempre como MTi, no MTI a veces. Ejemplo 2: Un algoritmo es siempre un algoritmo, no pasa a ser un método o infraestructura en un mismo documento.
• Evitar extranjerismos sin referenciar (p.e. si el docuemento está en español, como mínimo poner pie de página ante anglicismos).

Figuras

• Centradas.
• Sin deformar (conservar proporciones originales).
• Texto explicativo debajo y también centrado.
• Figuras referenciadas cerca de la propia figura y antes de aparecer, si es posible.
• Tratar de utilizar y crear imágenes de tipo vectorial para diagramas de flujo, etc. Imágenes de tipo vectorial no pixelan con cambios de zoom. Inkscape (libre, formato SVG o PDF vectorial), Corel (pago, formato propio), y otros muchos programas estilo Dia pueden generar imágenes de tipo vectorial. Powerpoint también puede exportar a PDFs vectoriales. Los PDFs vectoriales se pueden incluir en proyectos que se compilen con pdflatex.
• Un buscador para imágenes libres: http://search.creativecommons.org/

Tablas

• Centradas.
• Texto explicativo normalmente encima y también centrado.

Bibliografía

• Es necesario que todos los elementos de la bibliografía estén referenciados.
• El orden de los elementos debe ser el de aparición en el documento (ciertos autores prefieren orden alfabético).
• Tratar de evitar bibliografía del que solo se disponga una URL (foros, webs...). En caso de ser realmente necesario, es obligatorio poner la fecha de acceso: "(último acceso 22 de febrero de 2011)".
• En lugar de foros o webs, tratar de utilizar bibliografía científica: preferiblemente "Journals", o "Proceedings of Conferences" si no.
• Para localizar bibliografía científica, utiliza buscadores como Google Académico o IEEExplore que dispongan de la opción de importar citas a BibTex o semejante. Esto se activa en Google Académico hacia el final de la siguiente página de configuración.

Referencias a Bibliografía

• La regla general es citar la referencia sólo la primera vez que aparece. Excepciones: no se introduce en el resumen/abstract (sí en la introducción); se puede volver a citar cuando ha pasado un cierto número de páginas (p.ej. capítulos diferentes).
• Se deja un espacio entre la palabra y la referencia, como se hace en esta frase [1]. Es recomendable, además, que esta frase pueda leerse habiendo omitido la referencia (p.antiejemplo: léase [3] y [16]).

Fórmulas

• Referencias entre paréntesis (no corchetes).

Úlitmos consejos

• ¡Releer el documento entero mínimo una vez!

Específico PFCs UC3M

• Revisa la Matriz de Criterios de Evaluación de PFCs de la UC3M

Más enlaces de interés

• Consejos generales para la presentación de un documento.
• File:Formatobasicopararedactareportes.pdf