C omo Elaborar y Redactar un Informe como un Verdadero Ingeniero Software

Pablo S anchez
Dpto. Matem aticas, Estad stica y Computaci on Universidad de Cantabria Santander (Cantabria, Espa na) p.sanchez@unican.es

P. S anchez (MATESCO)

Elaborar Informes

1 / 16

Introducci on

Objetivos

Objetivos
Objetivos
Aprender a elaborar informes t ecnicos relativos a cualquier cuesti on relacionada con la Ingenier a del Software con la calidad y el rigor que se espera de un Ingeniero Software.

P. S anchez (MATESCO)

Elaborar Informes

2 / 16

Introducci on

Esquema General

Fases de Elaboraci on de un Informe T ecnico

1 2 3 4 5 6

Proceso de B usqueda de Informaci on Evaluaci on y S ntesis de las Fuentes Estructuraci on y Adecuaci on del Informe a sus Objetivos Redacci on Edici on y Entrega/Publicaci on Exposici on

P. S anchez (MATESCO)

Elaborar Informes

3 / 16

Proceso de B usqueda de Informaci on

Proceso de B usqueda de Informaci on

1

Libros cl asicos de Ingenier a del Software [Sommerville, 2004, Pressmann, 2003]. Est andares sobre Ingenier a del Software (SWEBOK, PMBOK) [Project Management Institute, 2004, Bourque and Dupuis, 2004]. Software Engineering Institute (SEI) ( http://www.sei.cmu.edu/). Fuentes espec cas de Informaci on acordes al tema del informe (ej. LOPD). Congresos y Revistas Cient cas (preguntar a expertos, dblp). Fuentes de Car acter General (ej. libros sobre Liderazgo de Equipos). Otras fuentes bibliogr acas (biblioteca, librer as online) (ojo con la editorial y fecha). Profesionales del sector (ej. profesores asociados). Internet (ojo, hay que saber ltrar, hay demasiada basura).
P. S anchez (MATESCO) Elaborar Informes 4 / 16

3 4

5 6 7

8 9

Selecci on de Fuentes

Fases de Elaboraci on de un Informe T ecnico

1 2 3 4 5 6

Proceso de B usqueda de Informaci on Evaluaci on y S ntesis de las Fuentes Estructuraci on y Adecuaci on del Informe a sus Objetivos Redacci on Edici on y Entrega/Publicaci on Exposici on

P. S anchez (MATESCO)

Elaborar Informes

5 / 16

Selecci on de Fuentes

Evaluaci on y S ntesis de las Fuentes

Evaluar la calidad de las fuentes (calidad de revistas y congresos cient cos, editoriales de los libros, reputaci on de los autores, citas, etc.). Analizar y seleccionar cuales son los temas m as relevantes actualmente (importancia/ ambito de aplicaci on/novedad). Identicar, entre las de calidad, cuales son las fuentes m as sint eticas y completas para abordar los temas seleccionados. NOTA: La informaci on de calidad suele estar disponible s olo en ingl es. NOTA: Solicitad ayuda al personal senior para decidir sobre la calidad de las fuentes.

P. S anchez (MATESCO)

Elaborar Informes

6 / 16

Estructuraci on

Fases de Elaboraci on de un Informe T ecnico

1 2 3 4 5 6

Proceso de B usqueda de Informaci on Evaluaci on y S ntesis de las Fuentes Estructuraci on y Adecuaci on del Informe a sus Objetivos Redacci on Edici on y Entrega/Publicaci on Exposici on

P. S anchez (MATESCO)

Elaborar Informes

7 / 16

Estructuraci on

Estructura de un Trabajo

Resumen No m as de 200 palabras describiendo los objetivos y motivaci on del trabajo. Introducci on No m as de de 2 p aginas detallando ambito, objetivos y resultados del trabajo. Contenido Tantas secciones como hagan falta para explicar los contenidos t ecnicos del trabajo. Conclusiones Debe resumir los puntos fundamentales del trabajo y sus contribuciones. Ap endice: Metodolog a* Descripci on del proceso seguido para la elaboraci on del trabajo.

P. S anchez (MATESCO)

Elaborar Informes

8 / 16

Estructuraci on

C omo Escribir una Buena Introducci on

Contexto Descripci on del ambito del documento. Deniciones generales. Longitud de 200 palabras. Motivaci on Por qu e es relevante dicho ambito (usar referencias). Tema del documento Sobre qu e parte espec ca de tal ambito trata este documento. Objetivo Cu al es el objetivo de este documento. NOTA: En las conclusiones debemos argumentar como hemos cubierto nuestros objetivos. Metodolog a Breve resumen del procedimiento seguido para elaborar el trabajo. Estructura Estructura del documento

P. S anchez (MATESCO)

Elaborar Informes

9 / 16

Redacci on

Fases de Elaboraci on de un Informe T ecnico

1 2 3 4 5 6

Proceso de B usqueda de Informaci on Evaluaci on y S ntesis de las Fuentes Estructuraci on y Adecuaci on del Informe a sus Objetivos Redacci on Edici on y Entrega/Publicaci on Exposici on

P. S anchez (MATESCO)

Elaborar Informes

10 / 16

Redacci on

Consejos de Estilo al Redactar un Informe T ecnico

1 2 3 4 5 6

Todo debe de estar ligado y la lectura debe ser uida. Cada secci on debe dar paso a la siguiente. Frases cortas y simples. Lenguaje sencillo, pero t ecnico y preciso. Tener en cuenta el conocimiento previo de los potenciales lectores. Usar ejemplos, guras y tablas para explicar conceptos abstractos dif ciles de entender. Cada secci on debe tener un objetivo y todo el texto debe servir para alcanzar dicho objetivo. Apoyarse en referencias cuando sea necesario. Intentar mantener la atenci on del lector.

8 9

P. S anchez (MATESCO)

Elaborar Informes

11 / 16

Edici on y Entrega

Fases de Elaboraci on de un Informe T ecnico

1 2 3 4 5 6

Proceso de B usqueda de Informaci on Evaluaci on y S ntesis de las Fuentes Estructuraci on y Adecuaci on del Informe a sus Objetivos Redacci on Edici on y Entrega/Publicaci on Exposici on

P. S anchez (MATESCO)

Elaborar Informes

12 / 16

Edici on y Entrega

Edici on de un Documento

1 2 3 4

Todas las referencias son correctas y est an citadas desde el texto. La maquetaci on es correcta. El texto est a libre de errores tipogr acos. Todas las guras, tablas y cuadros de texto tienen t tulo y est an referenciadas desde el texto. El ndice, ndice de guras, tablas, etc es correcto y est a actualizado. Las p aginas est an numeradas. Las cabeceras y pies de p agina son correctos.

5 6 7

P. S anchez (MATESCO)

Elaborar Informes

13 / 16

Exposici on

Fases de Elaboraci on de un Informe T ecnico

1 2 3 4 5 6

Proceso de B usqueda de Informaci on Evaluaci on y S ntesis de las Fuentes Estructuraci on y Adecuaci on del Informe a sus Objetivos Redacci on Edici on y Entrega/Publicaci on Exposici on

P. S anchez (MATESCO)

Elaborar Informes

14 / 16

Exposici on

Exposici on

1 2 3 4 5 6 7

Objetivo: Captar a la audiencia. Evitar transparencias llenas de texto (mejor guras). No leer las transparencias. Centrarse en lo general y no en lo particular. Dramatizar durante la presentaci on. Hablar de forma pausada y con convencimiento. Trasmitir por qu e el trabajo es importante sin entrar en excesivos detalles t ecnicos.

P. S anchez (MATESCO)

Elaborar Informes

15 / 16

Bibliograf a

Bibliograf a
Bourque, P. and Dupuis, R., editors (2004). Guide to the Software Engineering Body of Knowledge. IEEE (The Institute of Electrical and Electronics Engineers). Pressmann, R. (2003). Software Engineering: A Practitioners Approach. McGraw-Hill, 5 edition. Project Management Institute (2004). A Guide to the Project Management Body of Knowledge (PMBOK Guide). Technical Report ANSI/PMI 99-001-2004, American National Standard. Sommerville, I. (2004). Software Engineering. Addison Wesley, 7 edition.
P. S anchez (MATESCO) Elaborar Informes 16 / 16