Plantilla para la presentacin de Informes tcnicos bajo la norma IEEE

Servicio Nacional de Aprendizaje SENA Luis Antonio Prez Mesa 391674 Gestin Redes de Datos e-mail: luisap@ucentral.edu.co Junio 15 de 2012 Bogot, D.C
Resumen En este documento se describe la plantilla utilizada para la realizacin de los informes de los proyectos que involucran desarrollo de software en la Fundacin Universitaria San Martn. El documento tiene el formato IEEE para que los estudiantes lo utilicen tambin como plantilla en sus informes de proyecto. La gua en s respeta la mayora de normas establecidas, para servir como ejemplo de la aplicacin prctica de las mismas. Palabras Claves: Informe, Ingeniera de Software, Desarrollo de Software, Formato de Artculo de la IEEE.

Todos los subttulos irn en negrilla (En maysculas y minsculas) para facilitar su identificacin. Los subttulos principales se colocarn a un tamao mayor al texto normal. Las grficas y tablas debern ir numeradas, y dependiendo de su tamao podrn ocupar las dos columnas. Estas a su vez deben ir localizadas lo ms cerca posible al lugar de su referencia, en lo posible en la misma pgina. Las pginas deben ir enumeradas, en la parte inferior central. Adems: A. Resumen. Un resumen debe presentar de una manera concisa los objetivos, mtodos, resultados y conclusiones ms significativas del trabajo. La longitud mxima debe ser de 150 palabras y debe hacerse en espacio sencillo. El resumen es un conjunto de frases que enuncian los aspectos principales del artculo y responden tres aspectos principales: 1-Cual es la motivacin del trabajo y el alcance del mismo 2-Cual es la contribucin del trabajo 3-Cual es el resultado principal o aplicacin tpica Al final del resumen deben aparecer las "Palabras Clave". El objeto de estas palabras es la clasificacin del artculo en las bases de datos tcnicas y deben permitir una identificacin de los temas claves tratados en el mismo. B. Introduccin. En la introduccin se debe orientar al lector con respecto a la motivacin del trabajo. Esta seccin incluye: 1-La naturaleza de la investigacin 2-Los antecedentes de los trabajos previos 3-Los objetivos e importancia del trabajo 4-El mtodo o metodologa utilizada 5-La organizacin del material. [2]. C. Contenido. A continuacin se presentan algunas recomendaciones a tener en cuenta para la obtencin de un informe consistente. - Incluya en el informe los aspectos ms importantes de su investigacin y de sus resultados, asegurndose que la informacin sea de inters para otros investigadores de su rea. - Piense bien sus ideas antes de escribirlas. - Organice el material de manera lgica.

I. INTRODUCCION Se han detectado falencias en la mayora de los estudiantes de ltimos semestres en la elaboracin de informes escritos de los trabajos que realizan. Por esta razn 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 bsicas en el ejercicio profesional.. La gua aqu mostrada es un ejemplo de presentacin formal de artculos, extrada principalmente del documento "Metodologa para artculos: Memos de Investigacin" [1].. En este documento se describen cada una de las partes relevantes que debe poseer un informe tcnico. Las partes principales que debe contener un artculo son: resumen, introduccin, cuerpo, resultados, conclusiones, referencias, anexos y autores II. NORMAS TCNICAS (CONTENIDO) El ttulo debe ir centrado en la parte superior de la primera pgina, escrito en negrita y a un tamao superior al del texto normal, acompaado del nombre de los autores, fecha de realizacin y alguna forma de localizacin (direccin, correo electrnico, etc). El contenido debe realizarse a doble columna con una separacin entre las mismas de 1cm. Se recomienda que el texto sea escrito en "Times New Roman" de 10 a 12 puntos.

- Utilice y numere los subttulos 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 artculo. - El informe debe dar una descripcin completa de los objetivos de trabajo, del diseo experimental, si lo hay, de los mtodos utilizados, de los resultados obtenidos y de las conclusiones. - La longitud mxima del informe debe ser de 6 pginas. Se recomienda que el nmero de figuras no sea mayor de diez (10). El informe puede estar escrito a espacio sencillo o a uno y medio espacios En el contenido debe ir el marco terico y la estrategia global de solucin o desarrollo de los temas a presentar. : 1. Marco terico Se debe hacer una muy corta descripcin de los conceptos tericos y de herramientas necesitados para la elaboracin del proyecto. Debe tener muchas referencias en las que el lector del informe puede obtener ms informacin acerca de la teora necesaria para comprender el alcance del proyecto. Normalmente, este tem suele tener el de menor tamao 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. Tambin 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 informacin que quiere incluir en el marco terico. 2. Estrategia global de solucin o desarrollo de los temas a presentar Consiste en la descripcin 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 solucin de cada uno de ellos. D. Resultados obtenidos: Consiste en la descripcin de los escenarios en los que la aplicacin 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 ms tiempo requirieron y la forma en que los estudiantes resolvieron los problemas tcnicos que se tuvieron en la resolucin del problema. En los proyectos en los que sea posible, se deben hacer anlisis comparativos entre los diferentes escenarios en que se prob el aplicativo. En esta seccin se debe resumir los aspectos importantes logrados con el desarrollo presentado en al artculo. Para los desarrollos prcticos, este item se refiere a pruebas y resultados experimentales o en su defecto a estimativos realizados

E. Referencias. Toda afirmacin en el texto del informe procedente de otro documento o publicacin debe ir sustentada por su respectiva referencia. Toda referencia hecha en el texto debe aparecer en esta seccin. As mismo, toda referencia incluida en esta seccin debe haber sido mencionada en el texto. Las referencias pueden hacerse bien sea por orden de aparicin en el artculo en cuyo caso en el texto aparecen en forma de nmeros consecutivos; o pueden hacerse en el texto con el nombre del autor principal y la fecha de publicacin, en cuyo caso aparecen en esta seccin ordenadas en forma alfabtica. El concepto clave detrs de la referencia es que el lector del informe pueda identificar o eventualmente conseguir la referencia con la informacin suministrada por el autor. Por consiguiente una referencia incompleta o equivocada podra 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 edicin, el volumen y la pgina. En el caso de artculos 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 artculo de publicaciones peridicas se debe dar el nombre de los autores, el ttulo de la publicacin el ao, el volumen y las pginas. 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 cmo fue realizado el proyecto. A continuacin se describen los elementos sugeridos para su inclusin en el documento de informe: III CONCLUSIONES Deben estar claramente expresadas, estableciendo lo que se ha mostrado con el trabajo, qu limitaciones y ventajas existen, cul es la aplicacin principal de los resultados y qu recomendaciones se pueden dar para trabajos posteriores sobre el tema. Los estudiantes deben tener en cuenta que las conclusiones es normalmente la parte ms 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 autoevaluacin del proceso de desarrollo con el fin de mejorar el proceso de enseanza/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 enseanza/aprendizaje: los estudiantes deben describir las competencias que se adquirieron en la elaboracin del proyecto. Describir qu tan difcil fue con las bases tericas que se tenan, qu tpicos faltaron para hacer que el proceso de desarrollo fuera mejor. Esta informacin la contrasta el docente y el estudiante contra

2)

3)

4)

5) 6)

los objetivos del curso para verificar la utilidad del ejercicio en el proceso de adquisicin de competencias. Uso de herramientas: se deben indicar las fortalezas y debilidades que se tuvieron en el uso de herramientas de desarrollo Esta informacin es valiosa para el docente para evaluar otras herramientas de desarrollo en los cursos. Conclusiones del anlisis de resultados : del anlisis realizado pueden extraerse las conclusiones que apoyan o refutan las hiptesis planteadas en la descripcin del problema. Este suele ser el tem ms importante en un informe de investigacin. Manejo del tiempo: se debe hacer una reflexin del manejo del tiempo y de la forma en que se trabaj en equipo indicando si se percibi que era la ms adecuada o no. Aspectos a mejorar: que cosas se podran mejorar, proceso de enseanza/aprendizaje, etc. para lograr la mxima nota en los prximos proyectos. Otros: otras conclusiones que los estudiantes quieran compartir de su trabajo. IV. REFERENCIAS

Es el listado de pginas Web, libros, cdigo de ejemplo, etc. que fue revisado para la elaboracin del proyecto. Tambin 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 artculos IEEE y se deben presentar asi: [1].Facultad de Ingeniera Electrnica, Grupo de Investigacin 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 PRESENTACIN DE BIBLIOGRAFIA Y REFERENCIA BIBLIOGRFICA. 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 ms importantes. Se incluye aquellos anexos que no caben dentro del cuerpo del informe como planos, estadsticas etc.