Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid...

28
Redacci ´ on del Proyecto Fin de Carrera Daniel Borrajo Universidad Carlos III de Madrid 2007 Redacci ´ on del Proyecto Fin de Carrera 1

Transcript of Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid...

Page 1: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Redaccion del Proyecto Fin de Carrera

Daniel Borrajo

Universidad Carlos III de Madrid

2007

Redaccion del Proyecto Fin de Carrera 1

Page 2: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Indice

Redaccion del Proyecto Fin de Carrera 2

Page 3: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Algunas cuestiones previas

Para que sirve la memoria del proyecto: preparar alalumno en la redaccion de documentacion relativa aproyectos, informes tecnicos, . . .Que lenguaje utilizar: tecnico, no coloquialLas revisiones de la memoria: el director o tutor debeleerse la memoria antes de entregar la definitiva. Decidecuando se presentaHerramientas para escritura

Mundo Microsoft: Word, Emacs+MiKTeX, OpenOffice, otrasMundo Linux: Emacs (vi)+Latex,OpenOffice

Que apartados debe contener una memoria: acontinuacion

Redaccion del Proyecto Fin de Carrera 3

Page 4: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Algunas cuestiones previas

Para que sirve la memoria del proyecto: preparar alalumno en la redaccion de documentacion relativa aproyectos, informes tecnicos, . . .Que lenguaje utilizar: tecnico, no coloquialLas revisiones de la memoria: el director o tutor debeleerse la memoria antes de entregar la definitiva. Decidecuando se presentaHerramientas para escritura

Mundo Microsoft: Word, Emacs+MiKTeX, OpenOffice, otrasMundo Linux: Emacs (vi)+Latex,OpenOffice

Que apartados debe contener una memoria: acontinuacion

Redaccion del Proyecto Fin de Carrera 4

Page 5: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Algunas cuestiones previas

Para que sirve la memoria del proyecto: preparar alalumno en la redaccion de documentacion relativa aproyectos, informes tecnicos, . . .Que lenguaje utilizar: tecnico, no coloquialLas revisiones de la memoria: el director o tutor debeleerse la memoria antes de entregar la definitiva. Decidecuando se presentaHerramientas para escritura

Mundo Microsoft: Word, Emacs+MiKTeX, OpenOffice, otrasMundo Linux: Emacs (vi)+Latex,OpenOffice

Que apartados debe contener una memoria: acontinuacion

Redaccion del Proyecto Fin de Carrera 5

Page 6: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Algunas cuestiones previas

Para que sirve la memoria del proyecto: preparar alalumno en la redaccion de documentacion relativa aproyectos, informes tecnicos, . . .Que lenguaje utilizar: tecnico, no coloquialLas revisiones de la memoria: el director o tutor debeleerse la memoria antes de entregar la definitiva. Decidecuando se presentaHerramientas para escritura

Mundo Microsoft: Word, Emacs+MiKTeX, OpenOffice, otrasMundo Linux: Emacs (vi)+Latex,OpenOffice

Que apartados debe contener una memoria: acontinuacion

Redaccion del Proyecto Fin de Carrera 6

Page 7: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Algunas cuestiones previas

Para que sirve la memoria del proyecto: preparar alalumno en la redaccion de documentacion relativa aproyectos, informes tecnicos, . . .Que lenguaje utilizar: tecnico, no coloquialLas revisiones de la memoria: el director o tutor debeleerse la memoria antes de entregar la definitiva. Decidecuando se presentaHerramientas para escritura

Mundo Microsoft: Word, Emacs+MiKTeX, OpenOffice, otrasMundo Linux: Emacs (vi)+Latex,OpenOffice

Que apartados debe contener una memoria: acontinuacion

Redaccion del Proyecto Fin de Carrera 7

Page 8: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Estructura

Portada (1 pagina)Agradecimientos (1 pg.)Indice (1-3 pgs.)Introduccion (∼ 2-5 pgs.)Estado de la cuestion (∼ 20-30 pgs.)Gestion del proyecto (∼ 15-20 pgs.)Objetivos del PFC (1-2 pgs.)Memoria-Trabajo realizado. (∼ 50 pgs.)Resultados (∼ 20 pgs.)Conclusiones (∼ 2-5 pgs.)Futuras lıneas/trabajos (∼ 2-5 pgs.)BibliografıaAnexos

Redaccion del Proyecto Fin de Carrera 8

Page 9: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Portada

UNIVERSIDAD CARLOS III DE MADRIDESCUELA POLITECNICA SUPERIOR

Ingenierıa en InformaticaProyecto Fin de Carrera

Desarrollo de un sistema de reserva de vuelos

Autora: Dna. Ana Perez PerezDirector: Prof. Pedro Perez Perez Junio, 2007

Redaccion del Proyecto Fin de Carrera 9

Page 10: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Indice

Hasta tercer nivel de estructura del documentoNo debera aparecer ningun apartado unico (al nivel quesea). Es decir, no puede aparecer un 3.2.1 si no tenemosun 3.2.2Practicamente todas las herramientas permiten generarındice automaticamente

Redaccion del Proyecto Fin de Carrera 10

Page 11: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Introduccion

Descripcion muy general de lo que has hechoDentro de la informatica esta la XXX, .... Dentrode ella esta el YYY, ... Lo que pretendıa hacer eneste PFC es ...

Puede incluir los objetivosDebe incluir una ultima seccion que describa los demascapıtulos del PFC

En el capıtulo 2 se describira el estado de lacuestion donde...

Redaccion del Proyecto Fin de Carrera 11

Page 12: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Estado de la cuestion

Que es lo que se ha hecho en tu tema y por quienPiensa en algo que le sirva a alguien que se quieraintroducir rapidamente en el tema luego(libros-artıculos-personas importantes)Puede incluir la descripcion de lasherramientas/modelos/ideas que has utilizado para el PFCPuedes poner unas conclusiones (que es lo que noesta hecho)

Redaccion del Proyecto Fin de Carrera 12

Page 13: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Gestion del proyecto

Puedes incluir este apartado para contar como hasrealizado el proyectoPuede incluir informacion sobre: fases, paquetes detrabajo, tareas y subtareas, duracion, coste, . . .Puedes utilizar diagramas de Gannt (existen herramientaspara ello)

Redaccion del Proyecto Fin de Carrera 13

Page 14: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Objetivos del PFC

Que querıas hacer y que caracterısticas querıas quetuviera tu PFC

Construir un sistema que sea capaz de hacerXYZ. Ademas, elsistema/agente/arquitectura/modelo/metodologıa,deberıa ser: flexible, eficiente, eficaz, robusto,rapido, facil de usar, dinamico, adaptable, ...

Divide objetivos en subobjetivos

Redaccion del Proyecto Fin de Carrera 14

Page 15: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Memoria del trabajo realizado

Que has hecho, pasando desde una descripcion de altonivel hasta los detallesNada de describir las funciones una por una: solo unadescripcion generica por modulos/clasesSi quieres anadir el codigo o lo que hayas hecho, seincluye como anexo (comentado si es posible)

Redaccion del Proyecto Fin de Carrera 15

Page 16: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Estructura del trabajo realizado

IntroduccionArquitectura de la aplicacion (obligatorio grafico)

modulos de los que consta, entradas y salidas de losmismos, tipos de datos/documentos que se intercambianlos modulos, ...puede incluir algo equivalente a un diagrama de flujo o unalgoritmo de muy alto nivel (llamadas a modulos en lugarde a funciones de un lenguaje concreto)

Modelo de conocimiento de la aplicacionequivalente a un diagrama de clases, solo comentando lasde mas alto nivel (no las auxiliares) y los atributos massignificativos

Redaccion del Proyecto Fin de Carrera 16

Page 17: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Estructura del trabajo realizado (cont.)

Descripcion a alto nivel de cada modulofuncionalidad, entradas, salidas, submodulos, ...se deberan poner tambien los principales algoritmos enpseudo-codigodebe explicarse a traves de un ejemplo, o poner unaseccion luego con el ejemplo

Manual de usuario (se puede incluir como anexo)debe servir para que cualquier persona que no sepa nadade lo desarrollado pueda ejecutar la aplicacionequivalente a descripcion de la interfaz grafica paso porpaso (en caso de que haya interfaz) o como se ejecuta elsistema (sin interfaz)

Redaccion del Proyecto Fin de Carrera 17

Page 18: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Estructura del trabajo realizado (cont.)

Manual de referencia (se puede incluir como anexo)debe servir para que cualquier desarrollador posteriorpueda ampliar la aplicaciondebe contener detalles tecnicos de implementacion, comolenguaje utilizado, instalacion, ficheros generados, clasesgeneradas, como cambiar algo del codigo, ...sin describir una a una las clases o funciones desarrolladas

Redaccion del Proyecto Fin de Carrera 18

Page 19: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Resultados, Evaluacion, Ejemplos de uso

Cualquier cosa que sirva para demostrar que el trabajofunciona bien, o mejor que otros:

numero o tipo de problemas que resuelvetiempo que tarda en hacerlo bajo diferentes circunstancias% de acierto, o de recuperacion, o % de objetivoscubiertos, ...encuestas de utilizacion, facilidad de manejo, . . .ejemplos de uso

Puede contener un presupuesto (o ser un apartadodiferente)

Coste de personal: numero de horas trabajadas × preciopor hora (incluye tiempo de tutor)Coste de equipos inventariables: compra o alquiler de losequipos utilizados, libros consultados, . . .Coste de material fungible: papel, toner, CDs, . . .Otros gastos: viajes realizados, encuadernacion, coste deinstalacion, coste de mantenimiento, . . .

Redaccion del Proyecto Fin de Carrera 19

Page 20: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Temas finales

Conclusiones: a muy alto nivel, que es lo que se puedesacar en claro de tu proyecto, ventajas e inconvenientesFuturas lıneas/trabajos: que se puede hacer sobre tutrabajo para ampliarlo/modificarlo, de forma que sea maseficiente, resuelva mas problemas, ...Bibliografıa: debe contener todas las referencias al trabajode otros. Consultar otros PFCs para formato en el que sedebe referenciarAnexos: los que se considere imprescindibles

Redaccion del Proyecto Fin de Carrera 20

Page 21: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Altamente recomendable pasarle un corrector ortografico(Word, ispell)Hacer una pagina Web con parte de la memoria y con ladescarga del software (si es publico)Cualquier aportacion de otra persona debe aparecerreferenciada en el texto

desde [1] para referencias cortashasta [Perez y Alonso, 1989] para referencias largasse deben referenciar las paginas Web relevantes

Redaccion del Proyecto Fin de Carrera 21

Page 22: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Altamente recomendable pasarle un corrector ortografico(Word, ispell)Hacer una pagina Web con parte de la memoria y con ladescarga del software (si es publico)Cualquier aportacion de otra persona debe aparecerreferenciada en el texto

desde [1] para referencias cortashasta [Perez y Alonso, 1989] para referencias largasse deben referenciar las paginas Web relevantes

Redaccion del Proyecto Fin de Carrera 22

Page 23: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Altamente recomendable pasarle un corrector ortografico(Word, ispell)Hacer una pagina Web con parte de la memoria y con ladescarga del software (si es publico)Cualquier aportacion de otra persona debe aparecerreferenciada en el texto

desde [1] para referencias cortashasta [Perez y Alonso, 1989] para referencias largasse deben referenciar las paginas Web relevantes

Redaccion del Proyecto Fin de Carrera 23

Page 24: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Cualquier figura o tabla debe referenciarse en el texto(hablar de ella en el texto y poner una referencia como: LaFigura XX muestra ...) y debe tener un pie de figura/tablaindicativo (Figura XX. Arquitectura modular del sistema)Conviene estructurar el texto en capıtulos, secciones ysubsecciones. Ir mas alla no debe ser necesarionormalmenteLa primera vez que se utiliza un acronimo, debeespecificarse de donde viene. Por ejemplo, “La InteligenciaArtificial (IA) ...”

Redaccion del Proyecto Fin de Carrera 24

Page 25: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Cualquier figura o tabla debe referenciarse en el texto(hablar de ella en el texto y poner una referencia como: LaFigura XX muestra ...) y debe tener un pie de figura/tablaindicativo (Figura XX. Arquitectura modular del sistema)Conviene estructurar el texto en capıtulos, secciones ysubsecciones. Ir mas alla no debe ser necesarionormalmenteLa primera vez que se utiliza un acronimo, debeespecificarse de donde viene. Por ejemplo, “La InteligenciaArtificial (IA) ...”

Redaccion del Proyecto Fin de Carrera 25

Page 26: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Cualquier figura o tabla debe referenciarse en el texto(hablar de ella en el texto y poner una referencia como: LaFigura XX muestra ...) y debe tener un pie de figura/tablaindicativo (Figura XX. Arquitectura modular del sistema)Conviene estructurar el texto en capıtulos, secciones ysubsecciones. Ir mas alla no debe ser necesarionormalmenteLa primera vez que se utiliza un acronimo, debeespecificarse de donde viene. Por ejemplo, “La InteligenciaArtificial (IA) ...”

Redaccion del Proyecto Fin de Carrera 26

Page 27: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Se debe evitar la utilizacion de terminos en ingles. Si sedesea poner alguno, se incluira en italica o “con comillas”.Si se desea incluir la traduccion al ingles de unadeterminada palabra (psuedo-)castellana, se pondra, porejemplo, el retroceso (del ingles backtracking)...El texto debe estar ajustado (“justificado”) a los dos lados

Redaccion del Proyecto Fin de Carrera 27

Page 28: Redaccion del Proyecto Fin de Carrera´ - UC3M · 2007-07-24 · Universidad Carlos III de Madrid 2007 Redacci´on del Proyecto Fin de Carrera 1. Indice Redacci´on del Proyecto Fin

Cuestiones generales

Se debe evitar la utilizacion de terminos en ingles. Si sedesea poner alguno, se incluira en italica o “con comillas”.Si se desea incluir la traduccion al ingles de unadeterminada palabra (psuedo-)castellana, se pondra, porejemplo, el retroceso (del ingles backtracking)...El texto debe estar ajustado (“justificado”) a los dos lados

Redaccion del Proyecto Fin de Carrera 28