Guía estilo PFC [ Guia_Estilo_PFC ]
Contents
1. PFC Departamento de Lenguajes y Sistemas Inform ticos Metodolog a M trica 1 3 Metodolog a de planificaci n desarrollo y mantenimiento de Sistemas de Informaci n desarrollada por la Administraci n P blica espa ola Rational Unified Process RUP Proceso de desarrollo de sistemas orientados a objetos desarrollado por Rasional Rose El RUP se basa en el Unified Process UP y utiliza el Unified Modeling Language UML como notaci n Especificaci n de los requisitos del sistema Este apartado contiene una lista detallada y completa de los requisitos que debe cumplir el software funciones prestaciones restricciones de dise o y atributos y de los requisitos de las interfaces del software con el resto de los elementos del sistema y con el exterior La especificaci n de los requisitos del sistema se hace a partir de la informaci n obtenida mediante las t cnicas de recogida de informaci n entrevistas prototipado etc El contenido de este apartado seg n el est ndar IEEE Std 830 IEEE 1998 debe ser el siguiente Requisitos de interfaces externas interfaces de usuario interfaces hardware interfaces software e interfaces de comunicaciones Incluye una descripci n detallada de los requisitos de conexi n a otros sistemas hardware o software con los que el sistema debe interactuar bases de datos protocolos formatos de ficheros sistemas operativos etc Tambi n se detallar n los requisitos de interf2. de tener en cuenta los siguientes aspectos Habr de ser suficientemente descriptivo lo que implica huir de simplificaciones excesivas que tienden a una generalidad que no llega a cumplir con la funci n del t tulo Siempre es admisible subtitular con una frase corta pero explicativa si se quiere mantener un t tulo inicial que requiera de informaci n complementaria para su comprensi n No debe abusarse de la utilizaci n de las s glas que pueden crear confusi n sobre el objetivo principal del Proyecto En caso de usarse se recomienda que no se haga en el t tulo salvo que sea imprescindible sino que se introduzcan en el cuerpo de la memoria previa explicaci n de su significado 2 2 Memoria del Proyecto El PFC ha de documentarse mediante una memoria por escrito MPFC en adelante La estructura de este documento se describe a continuaci n e Portada ver modelo en el anexo A 2 e Primera hoja ver modelo en el anexo A 3 e ndices La MPFC debe contener los siguientes ndices Indice general tabla de contenidos del documento con n mero de p gina para cada secci n del mismo La MPFC debe contener al menos las siguientes secciones Introducci n Desarrollo del calendario Descripci n general del Proyecto Desarrollo del Proyecto Resumen Conclusiones Manual de Usuario Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos Manual
3. VY UCA iiig Recomendaciones para la realizaci n de la Documentaci n del Proyecto de Fin de Carrera Departamento de Lenguajes y Sistemas Inform ticos Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos INDICE 1 Introducci n 2 Documentaci n del Proyecto de Fin de Carrera 2 1 Solicitud del Proyecto de Fin de Carrera 2 2 Memoria del Proyecto 2 3 Documentaci n en CDROM 3 Presentaci n y Defensa 4 Bibliograf a 5 Anexos Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos 1 Introducci n Los estudios conducentes a las titulaciones de Ingeniero T cnico en Inform tica de Gesti n Ingeniero T cnico en Inform tica de Sistemas e Ingeniero en Inform tica tienen como objetivo la adquisici n por parte del alumno de un conjunto de aptitudes enfocadas a capacitatlo t cnicamente para afrontar el ejercicio de su profesi n con las garant as que requiere la sociedad Los planes de estudio se establecen para guiar al alumno a trav s del proceso necesario para alcanzar dicho objetivo de una forma adecuada de manera que obtenga adem s la confianza social y el reconocimiento como profesional propios de la formaci n universitaria Este proceso requiere el conocimiento de un corpus te rico y el manejo de un conjunto de t cnicas espec ficas del mbito de conocimientos que caracteriza a la Inform tica Entre otras el alumno debe ad
4. a calidad cient fico t cnica del trabajo 4 Bibliograf a e EEE 1998 IEEE Std 830 1998 Recommended Practice for Software Requeriments Specifications IEEE Computer Society 1998 e IEEE 1998 IEEE Std 829 1998 Standard for Software Test Documentation IEEE Computer Society 1998 5 Anexos A continuaci n se incluyen los modelos de Instancias y Documentos relacionados con la documentaci n del PFC referidos en este documento A 1 Solicitud del Proyecto Fin de Carrera A 2 Modelo de Portada de la Memoria del Proyecto Fin de Carrera A 3 Modelo de la primera hoja de la Memoria del Proyecto Fin de Carrera 12
5. aces de usuario incluyendo los prototipos de las pantallas y de los informes que el sistema deba generar Requisitos funcionales Contiene una descripci n detallada de las funciones del sistema Los requisitos funcionales responden a la pregunta de qu debe hacer el sistema Requisitos de rendimiento Se describen los requisitos del sistema relativos a su rendimiento tiempos de respuesta transacciones cr ticas etc Requisitos l gicos de la base de datos Incluye una descripci n de los requisitos l gicos de la informaci n que se almacena en la base de datos entidades de datos y sus relaciones tipos de accesos a los datos frecuencia de uso etc Restricciones de dise o Contiene todas las restricciones que se hayan identificado y que afecten al dise o del sistema Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos Atributos del sistema software Incluye una especificaci n de las propiedades que debe tener el sistema a desarrollar fiabilidad disponibilidad seguridad mantenibilidad y portabilidad Otros requisitos Se incluir n todos los requisitos que por su naturaleza no se hayan podido incluir en los apartados anteriores An lisis del Sistema En el an lisis del sistema se realizan modelos que ayudan a analizar y especificar la funci n informaci n y el comportamiento del sistema A continuaci n se detalla una forma de especificar el
6. de Instalaci n Referencias Anexos ndices de figuras y tablas indican el n mero la descripci n y la p gina en que aparece cada figura o tabla de la MPFC A continuaci n se describen las diferentes secciones que debe contener la MPFC Introducci n Esta secci n debe dar una visi n global de toda la MPFC Se compone de los siguientes apartados Objetivos Aparecen de manera expl cita los objetivos que se pretenden cubrir con la realizaci n del proyecto A menudo pueden diferenciarse un objetivo de car cter general cuya consecuci n requiere de una serie de objetivos espec ficos o secundarios En cualquier caso se sugiere que en este apartado aparezcan enumerados de forma concreta a fin de que el evaluador pueda analizar hasta qu punto el proyecto los aborda y cumple de forma satisfactoria Alcance Justificaci n del inter s y o la innovaci n que supone el proyecto explicando el problema que se pretende resolver y los posibles campos de aplicaci n En este apartado se incluir Identificaci n del producto mediante un nombre Se identifica y se le da un nombre al producto o a los productos resultantes del proyecto Qu hace y qu no hace el producto Se explica qu hacen los productos resultantes del proyecto y qu no ser n capaces de hacer Aplicaciones del sofware beneficios objetivos y metas Se detallan de manera precisa las posibles aplicaciones y beneficios del pr
7. do a tal efecto por la Direcci n de la Escuela Superior de Ingenier a que act e como supervisor del proyecto del alumno El presente documento ofrece una serie de recomendaciones y consejos pr cticos al alumno sobre la elaboraci n de la Documentaci n del Proyecto y sobre la Presentaci n y Defensa del mismo 2 Documentaci n del Proyecto de Fin de Carrera El PFC ha de documentarse mediante una memoria por escrito que deber contener al menos los apartados y aspectos que se indican en el apartado 2 2 Memoria del Proyecto En el caso de que el proyecto precise la inclusi n de listados de programas deber n adjuntarse los mismos sobre un soporte inform tico adecuado v ase el apartado 2 3 Documentaci n en CDROM as como las instrucciones y procedimientos necesarios para su instalaci n ejecuci n y comprobaci n Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos 2 1 Solicitud del Proyecto Fin de Carrera El alumno que quiera realizar un PFC solicitar la aceptaci n del mismo presentando en la Secretar a de Direcci n de la Escuela Superior de Ingenier a la Solicitud del PFC seg n el formato del anexo A 1 para lo cual el alumno deber contactar con su director para acordar el t tulo y el contenido de su PFC El t tulo del PFC deber ser indicativo del contenido del mismo si bien habr de evitarse que su longitud sea innecesariamente extensa este respecto el alumno ha
8. e tenga relaci n con el proyecto pero que por su naturaleza no se ajusta al contenido de ninguno de los apartados anteriores o que por su extensi n no pueda aparecer en el cuerpo de la memoria pero que es necesaria para la valoraci n del PFC Pueden citarse a modo de orientaci n y sin pretender ser exhaustivos los siguientes Entrevistas realizadas para la identificaci n de los requisitos del PFC Documentos de partida listados formularios etc que se han tenido en cuenta para determinar los requisitos del PFC Informaci n t cnica sobre caracter sticas de los equipos utilizados para la realizaci n del PFC cuando sta sea relevante Detalles t cnicos sobre la implementaci n del proyecto Etc 2 3 Documentaci n en CDROM Junto con las copias impresas de la memoria del PFC se debe depositar una copia en formato electr nico de la misma grabada en CDROM el cual debe ir rotulado en la car tula con los mismos datos que se incluyen en la portada de la MPFC t tulo del proyecto nombre del alumno y curso acad mico El contenido del CDROM debe ser al menos la MPFC en un formato est ndar imprimible Postscript o PDF los listados del c digo fuente organizados en subdirectotios utilizados u obtenidos como resultado del proyecto y las instrucciones y procedimientos necesarios para su instalaci n ejecuci n y comprobaci n Opcionalmente se podr n incluir tambi n los ficheros fuente del texto de la
9. gramaci n sistema Operativo normas particulares restricciones de hardware restricciones de seguridad restricciones de protocolos de comunicaci n etc Suposiciones y dependencias Se incluye cualquier factor que afecte a los requisitos Requisitos para futuras versiones Se incluye cualquier sugerencia para futuras versiones del sistema e Desarrollo del Proyecto El contenido de esta secci n se organizar seg n la modalidad del PFC Proyecto de Desarrollo de Aplicaciones Software Proyecto de Investigaci n etc A continuaci n se detalla el contenido de esta secci n para los Proyectos de Desarrollo de Aplicaciones Software e Proyecto de Desarrollo de Aplicaciones Software Este tipo de proyectos consisten en llevar a cabo las actividades necesarias para realizar el an lisis y especificaci n de los requisitos dise o codificaci n integraci n pruebas e instalaci n y aceptaci n de una aplicaci n software utilizando una determinada metodolog a de desarrollo de aplicaciones software Los apartados que integran esta secci n son los siguientes Metodolog a de desarrollo En este apartado se especificar la metodolog a de desarrollo utilizada para desarrollar la aplicaci n software as como las herramientas CASE que se hayan empleado Entre las principales metodolog as de desarrollo de aplicaciones software que se utilizan actualmente se encuentran las siguientes Recomendaciones Documentaci n del
10. izado e Conclusiones En este apartado se incluir una valoraci n global del trabajo realizado en el PFC y si procede posibles mejoras ampliaciones o trabajos relacionados que quedan por hacer y que tienen inter s para el tema tratado e Manual de Usuario El objetivo de este apartado es dar una visi n global y amplia del sistema desarrollado y dar a conocer a los usuarios finales las caracter sticas y las formas de uso del mismo Por tanto se describir n las funciones y forma de usar correctamente el sistema e Manual de Instalaci n Incluye las instrucciones y procedimientos necesarios para la instalaci n y ejecuci n del sistema desarrollado El manual de instalaci n se incluir en el CDROM que contiene la documentaci n del PFC v ase el apartado 2 3 Documentaci n en CDROM 10 Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos e Referencias Contiene una lista de referencias bibliogr ficas que se citen expl citamente en el documento y la bibliograf a consultada para la elaboraci n del proyecto As mismo se incluyen las referencias a documentos electr nicos disponibles en Internet citados en el documento o consultados v ase el apartado Lista de Referencias del documento Gu a de estilo para la realizaci n de un trabajo monogr fico elaborado por el Departamento de Lenguajes y Sistemas Inform ticos e Anexos Incluye toda aquella informaci n complementaria qu
11. memoria en el formato espec fico del procesador de textos utilizado 3 Presentaci n y Defensa La defensa del PFC que tendr car cter p blico consistir en la presentaci n del proyecto ante en Tribunal Evaluador mediante una exposici n de los objetivos m todos medios utilizados y resultados obtenidos en relaci n con los que se especificaron al presentar la solicitud del PFC y en la que se hagan constar los m ritos y logros t cnicos obtenidos por el alumno y su relaci n con las materias propias de la titulaci n 11 Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos Se recomienda al alumno la construcci n de un documento que sea proyectable mediante medios electr nicos H TML herramientas de elaboraci n de presentaciones etc y que a modo de resumen tambi n podr entregar al Tribunal antes de su presentaci n Tambi n es interesante utilizar cuantos medios sean necesarios demostraciones interactivas v deos presentaciones multimedia etc para que se demuestre la val a de los trabajos realizados de forma clara y sencilla En particular los colores y efectos de animaci n en las presentaciones deber n utilizarse en la medida en que contribuyan a la claridad de la exposici n evitando el abuso de los mismos Aunque la imagen de un proyecto tambi n es importante puesto que el proyecto hay que hacerlo atractivo comercialmente se tiene que procurar mantener y resaltar l
12. modelo de an lisis del sistema siguiendo un enfoque orientado a las funciones enfoque estructurado y un enfoque orientado a objetos utilizando la notaci n UML Enfoque orientado a funciones enfoque estructurado Modelo funcional Diagramas de flujos de datos Diccionario de datos Descripci n detallada de las funciones Modelo conceptual de datos Diagrama entidad interrelaci n extendido Definici n de entidades e interrelaciones Modelo de comportamiento Diagramas de transici n de estados Enfoque orientado a objetos notaci n UML Modelo de casos de uso Especificaci n de casos de uso Diagramas de casos de uso Modelo conceptual de datos Diagrama de clases conceptuales conceptos relevantes del mundo real Modelo de comportamiento del sistema Diagramas de secuencia de sistemas Contratos de las operaciones del sistema Modelo de estados Diagramas de estado Dise o del Sistema El dise o del sistema es la actividad de aplicar diferentes t cnicas y principios con el prop sito de definir un sistema con el suficiente detalle para que se pueda implementar El Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos resultado del dise o es el dise o de la arquitectura del sistema software dise o de la base de datos dise o detallado de los programas y dise o de las interfaces A continuaci n se detalla una forma de especifica
13. n de las pruebas es necesaria para una buena organizaci n de las mismas continuaci n se indican los distintos documentos de trabajo de las pruebas seg n el est ndar IEEE Std 829 IEEE 1998 Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos Pian de pruebas resultado de la fase de planificaci n de las pruebas Especificaci n del dise o de pruebas resultado de la fase de dise o de pruebas Especificaci n de los casos de prueba descripci n de los casos de prueba identificados en la especificaci n del dise o de pruebas datos de prueba resultados esperados etc Especificaci n de los procedimientos de prueba descripci n de los procedimientos de ejecuci n de los casos de prueba Documentaci n de la ejecuci n de las pruebas los documentos de especificaci n de los casos de prueba y de especificaci n de los procedimientos de prueba son los documentos de entrada de la ejecuci n de las pruebas Cada ejecuci n de pruebas genera dos tipos de documentos Hist rico de pruebas documentar todos los hechos relevantes ocurridos durante la ejecuci n de las pruebas Informe de incidentes ocurridos documentar cada incidente por ejemplo bloqueo de teclado interrupci n de las pruebas debido a un corte de electricidad etc ocutrido durante la prueba y que requiera un estudio posterior e Resumen Incluye un breve resumen de lo m s destacable del trabajo real
14. oyecto Definiciones acr nimos y abreviaturas Se incluye un glosario que contendr una lista de definiciones de t rminos acr nimos o siglas y abreviaturas particulares que se utilizan en el documento y que convenga rese ar para facilitar su lectura y evitar ambig edades Toda esta informaci n organizada y clasificada convenientemente se podr recoger tambi n en uno o varios ap ndices al final del documento Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos Visi n general En este apartado se describir la organizaci n y el contenido del resto de la MPFC e Desarrollo del calendario Esta secci n incluye una planificaci n temporal del desarrollo del proyecto por ejemplo mediante un diagrama de Gantt seguimiento del desarrollo del proyecto y porcentaje de esfuerzo dedicado a las diferentes fases del proceso de desarrollo e Descripci n general del proyecto En esta secci n se dar una visi n general del proyecto ampliando el contenido de la Introducci n de la MPFC Consta de los siguientes apartados Perspectiva del producto Indicar si el producto es independiente o forma parte de un sistema mayor Se especifica si el proyecto es independiente es continuaci n de otro anterior o si se continuar el desarrollo en proyectos posteriores Interfaces de sistema Diferentes interacciones del sistema a desarrollar con otros sistemas Interfaces de u
15. quirir la habilidad para dise ar implementar y evaluar la calidad de herramientas computacionales para lo cual se estima como una ayuda inestimable la realizaci n de un proyecto que culmine los estudios del alumno El establecimiento de un Proyecto de Fin de Carrera PFC en adelante asume esta funci n y se fundamenta en la justificaci n que se ha dado para dicha necesidad formativa as como la norma habitual en las Ingenier as Su car cter es obligatorio para la obtenci n del t tulo de Ingeniero T cnico en Inform tica de Gesti n Ingeniero T cnico en Inform tica de Sistemas e Ingeniero en Inform tica y supone una carga lectiva de 6 cr ditos como se define en los correspondientes Planes de Estudios Estos Planes de Estudio estipulan que el PFC se podr defender una vez que se hayan superado todas las asignaturas de la carrera con excepci n del propio proyecto En lo referente a su definici n se trata de un trabajo individual cuya realizaci n y posterior defensa deben probar que el alumno es capaz de manejar y aplicar los conocimientos adquiridos de forma rigurosa y met dica valorar y elegir las herramientas necesarias para llevar a cabo el desarrollo que implique la realizaci n de su proyecto y mostrar la habilidad t cnica y creativa propias de un profesional de la Inform tica La certificaci n del cumplimiento de estas condiciones por parte de cada alumno que haya de defenderlo ser misi n de un Tribunal Evaluador designa
16. r el dise o del sistema siguiendo un enfoque orientado a las funciones y un enfoque orientado a objetos utilizando la notaci n UML Enfoque orientado a funciones enfoque estructurado Arquitectura del sistema software Dise o de la base de datos Dise o l gico de la base de datos Dise o f sico de la base de datos Dise o de arquitectura modular del sistema Diagramas de estructura de cuadros Dise o de la interfaz intermodular Dise o procedimental Dise o detallado de los programas Dise o de interfaces Interfaces con sistemas externos Interfaces de usuario Enfoque orientado a objetos notaci n UML Arquitectura del sistema software Dise o de la capa de gesti n de datos Dise o de la capa de dominio Diagrama de clases de dise o describe las clases software y sus operaciones Diagramas de secuencia definen la interacci n entre las clases de objetos para responder a un evento externo Contratos de las operaciones definen qu hacen las operaciones de las clases de objetos Dise o de la capa de presentaci n e Codificaci n Incluye un breve resumen de los aspectos m s relevantes de la implementaci n de la aplicaci n software Los listados del c digo fuente utilizados u obtenidos como resultado del PFC se incluir n en el CDROM que contiene la documentaci n del PFC v ase el apartado 2 3 Documentaci n en CDROM e Pruebas y validaci n La documentaci
17. suario Caracter sticas l gicas de la interfaz y se discutir n algunas cuestiones relativas a su optimizaci n Interfaces hardware Descripci n del modo de acceso y de comunicaci n del sistema con otros dispositivos hardware Interfaces software Prop sito de la interfaz y su definici n en cuanto a contenido y formato Interfaces de comunicaciones Limitaciones de memoria Caracter sticas especiales de memoria que debe tener el entorno en el que se utilice el sistema a desarrollar Operaciones Modos de operaci n de los distintos grupos de usuarios y las operaciones de copia de seguridad y recuperaci n Requisitos de adaptaci n a la ubicaci n Consideraciones relativas a la adaptaci n del sistema a su ubicaci n que no se hayan descrito en los subapartados anteriores Recomendaciones Documentaci n del PFC Departamento de Lenguajes y Sistemas Inform ticos Funciones del producto Contiene una descripci n general de las funciones principales del PFC Las funciones estar n organizadas de manera que se facilite la comprensi n por parte del usuario Caracter sticas de los usuarios En este apartado se indica el tipo de usuario al que se dirige el PFC nivel de conocimientos experiencia etc Restricciones generales Se describen las restricciones generales que se deben tener en cuenta al realizar el proyecto tales como el empleo de determinadas metodolog as de desarrollo lenguajes de pro
Download Pdf Manuals
Related Search