Plantilla para la presentación de Informes técnicos bajo la norma IEEE Servicio Nacional de Aprendizaje SENA Luis Antonio Pérez Mesa 391674 Gestión Redes de Datos e-mail:
[email protected] Junio 15 de 2012 Bogotá, D.C 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 IEEE para que los estudiantes lo utilicen también como plantilla en sus informes de proyecto. La guía en sí respeta la mayoría de normas establecidas, para servir como ejemplo de la aplicación práctica de las mismas.
Todos los subtítulos irán en negrilla (En mayúsculas y minúsculas) para facilitar su identificación. Los subtítulos principales se colocarán a un tamaño mayor al texto normal. Las gráficas y tablas deberán ir numeradas, y dependiendo de su tamaño podrán ocupar las dos columnas. Estas a su vez deben ir localizadas lo más cerca posible al lugar de su referencia, en lo posible en la misma página. Las páginas deben ir enumeradas, en la parte inferior central.
Palabras Claves: Informe, Ingeniería de Software, Desarrollo de Software, Formato de Artículo de la IEEE.
Ademàs: A. Resumen. Un resumen debe presentar de una manera concisa los objetivos, métodos, resultados y conclusiones más significativas del trabajo. La longitud máxima debe ser de 150 palabras y debe hacerse en espacio sencillo.
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 quiere fortalecer 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 este tipo de habilidades son consideradas como básicas en el ejercicio profesional..
El resumen es un conjunto de frases que enuncian los aspectos principales del artículo y responden tres aspectos principales: 1-Cual es la motivación del trabajo y el alcance del mismo 2-Cual es la contribución del trabajo 3-Cual es el resultado principal o aplicación típica Al final del resumen deben aparecer las "Palabras Clave". El objeto de estas palabras es la clasificación del artículo en las bases de datos técnicas y deben permitir una identificación de los temas claves tratados en el mismo.
La guía aquí mostrada es un ejemplo de presentación formal de artículos, extraída principalmente del documento "Metodología para artículos: Memos de Investigación" [1].. En este documento se describen cada una de las partes relevantes que debe poseer un informe técnico. Las partes principales que debe contener un artículo son: resumen, introducción, cuerpo, resultados, conclusiones, referencias, anexos y autores
B. Introducción. En la introducción se debe orientar al lector con respecto a la motivación del trabajo. Esta sección incluye: 1-La naturaleza de la investigación 2-Los antecedentes de los trabajos previos 3-Los objetivos e importancia del trabajo 4-El método o metodología utilizada 5-La organización del material. [2]. C. Contenido. A continuación se presentan algunas recomendaciones a tener en cuenta para la obtención de un informe consistente. - Incluya en el informe los aspectos más importantes de su investigación y de sus resultados, asegurándose que la información sea de interés para otros investigadores de su área. - Piense bien sus ideas antes de escribirlas. - Organice el material de manera lógica.
II. NORMAS TÉCNICAS (CONTENIDO) El título debe ir centrado en la parte superior de la primera página, escrito en negrita y a un tamaño superior al del texto normal, acompañado del nombre de los autores, fecha de realización y alguna forma de localización (dirección, correo electrónico, etc). El contenido debe realizarse a doble columna con una separación entre las mismas de 1cm. Se recomienda que el texto sea escrito en "Times New Roman" de 10 a 12 puntos.
1
- Utilice y numere los subtítulos para facilitar el trabajo del lector. - Revise completamente el informe y elimine anglicismos, palabras rebuscadas o de poco uso y las figuras que no contribuyan al entendimiento o soporte adecuado de los planteamientos expresados en el artículo. - El informe debe dar una descripción completa de los objetivos de trabajo, del diseño experimental, si lo hay, de los métodos utilizados, de los resultados obtenidos y de las conclusiones. - La longitud máxima del informe debe ser de 6 páginas. Se recomienda que el número de figuras no sea mayor de diez (10). El informe puede estar escrito a espacio sencillo o a uno y medio espacios
E. Referencias. Toda afirmación en el texto del informe procedente de otro documento o publicación debe ir sustentada por su respectiva referencia. Toda referencia hecha en el texto debe aparecer en esta sección. Así mismo, toda referencia incluida en esta sección debe haber sido mencionada en el texto. Las referencias pueden hacerse bien sea por orden de aparición en el artículo en cuyo caso en el texto aparecen en forma de números consecutivos; o pueden hacerse en el texto con el nombre del autor principal y la fecha de publicación, en cuyo caso aparecen en esta sección ordenadas en forma alfabética. El concepto clave detrás de la referencia es que el lector del informe pueda identificar o eventualmente conseguir la referencia con la información suministrada por el autor. Por consiguiente una referencia incompleta o equivocada podría disminuir la autoridad y el valor del informe. En caso de libros se debe dar el nombre de los autores, la fecha, la editorial, el editor o autor, la edición, el volumen y la página.
En el contenido debe ir el marco teórico y la estrategia global de solución o desarrollo de los temas a presentar. : 1. 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ño en 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.
En el caso de artículos en conferencias se debe dar el nombre de los autores el nombre de la conferencia, el nombre del editor, el lugar, la fecha , etc. En el caso de un artículo de publicaciones periódicas se debe dar el nombre de los autores, el título de la publicación el año, el volumen y las páginas. Con cada proyecto de software se deberá entregar un informe. [3] El informe debe ser creado completamente por los estudiantes 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: III CONCLUSIONES
2. Estrategia global de solución o desarrollo de los temas a presentar Consiste en la descripción de la forma en que se va a tratar de resolver el problema. Normalmente incluye la forma en que el problema se partirá en subproblemas y la forma en que se integrará la solución de cada uno de ellos.
Deben estar claramente expresadas, estableciendo lo que se ha mostrado con el trabajo, qué limitaciones y ventajas existen, cuál es la aplicación principal de los resultados y qué recomendaciones se pueden dar para trabajos posteriores sobre el tema.
D. Resultados obtenidos: Consiste en la descripción de los escenarios en los que la aplicación funciona y los escenarios en los que no funcionó y las razones por las cuales no se logró resolver los errores. Se deben describir los problemas que más tiempo requirieron y la forma en que los estudiantes resolvieron los problemas técnicos que se tuvieron en la resolución del problema. En los proyectos en los que sea posible, se deben hacer análisis comparativos entre los diferentes escenarios en que se probó el aplicativo. En esta sección se debe resumir los aspectos importantes logrados con el desarrollo presentado en al artículo. Para los desarrollos prácticos, este item se refiere a pruebas y resultados experimentales o en su defecto a estimativos realizados
Los estudiantes deben tener en cuenta que las conclusiones es normalmente la parte más importante del informe puesto que en ellas se hace un balance del trabajo realizado desde varios puntos de vista. Se sugiere que sea un ejercicio de autoevaluación del proceso de desarrollo con el fin de mejorar el proceso de enseñanza/aprendizaje. Adicionalmente, los estudiantes deben tener claro que las conclusiones siempre tienen que referirse al trabajo realizado, nunca se pueden hacer conclusiones que, aunque sean correctas, no se desprendan del trabajo del estudiante. Se sugiere que en las conclusiones se aborden los siguientes temas: 1) Proceso de enseñanza/aprendizaje: los estudiantes deben describir las competencias que se adquirieron en la elaboración del proyecto. Describir qué tan difícil fue con las bases teóricas que se tenían, qué tópicos faltaron para hacer que el proceso de desarrollo fuera mejor. Esta información la contrasta el docente y el estudiante contra
2
2)
3)
4)
5) 6)
los objetivos del curso para verificar la utilidad del ejercicio en el proceso de adquisición de competencias. Uso de herramientas: se deben indicar las fortalezas y debilidades que se tuvieron en el uso de herramientas de desarrollo Esta información es valiosa para el docente para evaluar otras herramientas de desarrollo en los cursos. Conclusiones del análisis de resultados: del análisis realizado pueden extraerse las conclusiones que apoyan o refutan las hipótesis planteadas en la descripción del problema. Este suele ser el ítem más importante en un informe de investigación. Manejo del tiempo: se debe hacer una reflexión del manejo del tiempo y de la forma en que se trabajó en equipo indicando si se percibió que era la más adecuada o no. Aspectos a mejorar: que cosas se podrían mejorar, proceso de enseñanza/aprendizaje, etc. para lograr la máxima nota en los próximos proyectos. Otros: otras conclusiones que los estudiantes quieran compartir de su trabajo. IV. REFERENCIAS
Es el listado de páginas Web, libros, código de ejemplo, etc. que fue revisado para la elaboración del proyecto. También se suele hacer referencia a conversaciones informales con el docente, monitor u otros estudiantes que sirvieron para resolver dudas en el desarrollo del proyecto. Las referencias a los recursos dentro del texto deben tener el formato utilizado en los artículos IEEE y se deben presentar asi: [1].Facultad de Ingeniería Electrónica, Grupo de Investigación en Telecomunicaciones. Universidad Central 2003. [2] J. W. Hagge, Senior Member, IEEE, and L. L. Grigsby, “Preparation of a Formatted Technical Work for the IEEE Power Engineering Society”, http://ingenieria.sanmartin.edu.co:9673/ieee/Documentacion/f ormato.doc [3] Si son libros tener en cuenta la norma ICONTEC PARA LA PRESENTACIÓN DE BIBLIOGRAFIA Y REFERENCIA BIBLIOGRÁFICA. IV. ANEXOS (OPCIONAL SI LOS HAY) Se incluyen los documentos que hacen parte del proyecto pero cuyo nivel de detalle pueden llegar a distraer al lector del informe de los aspectos más importantes. Se incluye aquellos anexos que no caben dentro del cuerpo del informe como planos, estadísticas etc.
3
