Edwin

Plantilla para la presentación de Informes de Proyectos que Involucran Desarrollo de Software en la Fundación Universitaria San Martín

Msc. Rodrigo Moreno Serrano

Resumen – En este documento se describe la plantilla utilizada para la realización de los informes de los proyectos que involucran desarrollo de software en la Fundación Universitaria San Martín. El documento tiene el formato IEEEpara que los estudiantes lo utilicen también como plantilla en sus informes de proyecto.

Palabras Claves: Informe, Ingeniería de Software, Desarrollo de Software, Formato de Artículo de la IEEE.


I. INTRODUCCION

Se han detectado falencias en la mayoría de los estudiantes de últimos semestres en la elaboración de informes escritos de los trabajos que realizan. Por esta razón se quierefortalecer este tipo de habilidades desde primeros semestres. Lo que se pretende es que los estudiantes se acostumbren a documentar su trabajo de una manera estructurada puesto que, en la Facultad de Ingeniería de la Fundación Universitaria San Martín (FUSM), este tipo de habilidades son consideradas como básicas en el ejercicio profesional de la ingeniería. El informe se exigirá desde el primercurso de programación. A continuación se hacen una serie de sugerencias para la creación del informe. La Facultad es consciente de que cada proyecto tiene sus particularidades y por lo tanto estas sugerencias, sólo se deben ver como guías para la elaboración del informe.

II. CONTENIDO

Con cada proyecto de software se deberá entregar un informe. El informe debe ser creado completamente por losestudiantes puesto que son ellos las únicas personas que saben cómo fue realizado el proyecto. A continuación se describen los elementos sugeridos para su inclusión en el documento de informe:

A. Resumen
Consiste en una descripción breve de los principales puntos del trabajo, esto es, objetivos, estrategias utilizadas y conclusiones, así como los aportes y resultados del trabajo. El resumencontará además con un listado de palabras claves del trabajo que podrían ser utilizadas por un buscador en Internet para el indexamiento del documento. Debe tener un máximo de 150 palabras.


B. Introducción
Consiste en una breve descripción de la motivación por la cual se realizó el trabajo. Normalmente incluye los objetivos del proyecto, antecedentes (trabajos similares realizados por otraspersonas) y una guía de cómo leer

C. Marco teórico
Se debe hacer una muy corta descripción de los conceptos teóricos y de herramientas necesitados para la elaboración del proyecto. Debe tener muchas referencias en las que el lector del informe puede obtener más información acerca de la teoría necesaria para comprender el alcance del proyecto. Normalmente, este ítem suele tener el de menor tamañoen el informe puesto que lo que se pretende en el informe es mostrar el trabajo realizado y no los conocimientos previos que se deben tener para comprenderlo. También se debe tener presente que los estudiantes no pueden incluir texto de otras fuentes sin hacer la respectiva referencia. Se recomienda que el estudiante haga un resumen de la información que quiere incluir en el marco teórico.

D.Descripción del problema
Consiste en la descripción del problema a solucionar. Se deben describir en qué escenarios debe funcionar el programa (hardware, software, configuración, datos de entrada) y en cuales no. También es útil en algunos casos mostrar ejemplos de la forma en que deberían funcionar las diferentes opciones del aplicativo. Se deben describir los productos que se entregarán a todoslos niveles (manuales, javadocs, archivos de prueba, “ejecutables”, etc.). En algunos casos, se describen las hipótesis que se piensan validar o refutar en el trabajo. En resumen, es una descripción breve de los requerimientos del sistema. Se sugiere que el marco teórico vaya antes de la descripción del problema puesto que en este ítem pueden necesitarse los conocimientos que aparecen en él....