Cmo Elaborar y Redactar un Informe como un o Verdadero Ingeniero Software

Pablo Snchez a
Dpto. Matemticas, Estad a stica y Computacin o Universidad de Cantabria Santander (Cantabria, Espaa) n p.sanchez@unican.es

P. Snchez (MATESCO) a

Elaborar Informes

1 / 16

Introduccin o

Objetivos

Objetivos
Objetivos
Aprender a elaborar informes tcnicos relativos a cualquier cuestin e o relacionada con la Ingenier del Software con la calidad y el rigor que se a espera de un Ingeniero Software.

P. Snchez (MATESCO) a

Elaborar Informes

2 / 16

Introduccin o

Esquema General

Fases de Elaboracin de un Informe Tcnico o e

1 2 3 4 5 6

Proceso de Bsqueda de Informacin u o Evaluacin y S o ntesis de las Fuentes Estructuracin y Adecuacin del Informe a sus Objetivos o o Redaccin o Edicin y Entrega/Publicacin o o Exposicin o

P. Snchez (MATESCO) a

Elaborar Informes

3 / 16

Proceso de Bsqueda de Informacin u o

Proceso de Bsqueda de Informacin u o

1

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

3 4

5 6 7

8 9

Seleccin de Fuentes o

Fases de Elaboracin de un Informe Tcnico o e

1 2 3 4 5 6

Proceso de Bsqueda de Informacin u o Evaluacin y S o ntesis de las Fuentes Estructuracin y Adecuacin del Informe a sus Objetivos o o Redaccin o Edicin y Entrega/Publicacin o o Exposicin o

P. Snchez (MATESCO) a

Elaborar Informes

5 / 16

Seleccin de Fuentes o

Evaluacin y S o ntesis de las Fuentes

Evaluar la calidad de las fuentes (calidad de revistas y congresos cient cos, editoriales de los libros, reputacin de los autores, citas, o etc.). Analizar y seleccionar cuales son los temas ms relevantes a actualmente (importancia/mbito de aplicacin/novedad). a o Identicar, entre las de calidad, cuales son las fuentes ms sintticas y a e completas para abordar los temas seleccionados. NOTA: La informacin de calidad suele estar disponible slo en ingls. o o e NOTA: Solicitad ayuda al personal senior para decidir sobre la calidad de las fuentes.

P. Snchez (MATESCO) a

Elaborar Informes

6 / 16

Estructuracin o

Fases de Elaboracin de un Informe Tcnico o e

1 2 3 4 5 6

Proceso de Bsqueda de Informacin u o Evaluacin y S o ntesis de las Fuentes Estructuracin y Adecuacin del Informe a sus Objetivos o o Redaccin o Edicin y Entrega/Publicacin o o Exposicin o

P. Snchez (MATESCO) a

Elaborar Informes

7 / 16

Estructuracin o

Estructura de un Trabajo

Resumen No ms de 200 palabras describiendo los objetivos y a motivacin del trabajo. o Introduccin No ms de de 2 pginas detallando mbito, objetivos y o a a a resultados del trabajo. Contenido Tantas secciones como hagan falta para explicar los contenidos tcnicos del trabajo. e Conclusiones Debe resumir los puntos fundamentales del trabajo y sus contribuciones. Apndice: Metodolog Descripcin del proceso seguido para la e a* o elaboracin del trabajo. o

P. Snchez (MATESCO) a

Elaborar Informes

8 / 16

Estructuracin o

Cmo Escribir una Buena Introduccin o o

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

P. Snchez (MATESCO) a

Elaborar Informes

9 / 16

Redaccin o

Fases de Elaboracin de un Informe Tcnico o e

1 2 3 4 5 6

Proceso de Bsqueda de Informacin u o Evaluacin y S o ntesis de las Fuentes Estructuracin y Adecuacin del Informe a sus Objetivos o o Redaccin o Edicin y Entrega/Publicacin o o Exposicin o

P. Snchez (MATESCO) a

Elaborar Informes

10 / 16

Redaccin o

Consejos de Estilo al Redactar un Informe Tcnico e

1 2 3 4 5 6

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

8 9

P. Snchez (MATESCO) a

Elaborar Informes

11 / 16

Edicin y Entrega o

Fases de Elaboracin de un Informe Tcnico o e

1 2 3 4 5 6

Proceso de Bsqueda de Informacin u o Evaluacin y S o ntesis de las Fuentes Estructuracin y Adecuacin del Informe a sus Objetivos o o Redaccin o Edicin y Entrega/Publicacin o o Exposicin o

P. Snchez (MATESCO) a

Elaborar Informes

12 / 16

Edicin y Entrega o

Edicin de un Documento o

1 2 3 4

Todas las referencias son correctas y estn citadas desde el texto. a La maquetacin es correcta. o El texto est libre de errores tipogrcos. a a Todas las guras, tablas y cuadros de texto tienen t tulo y estn a referenciadas desde el texto. El ndice, ndice de guras, tablas, etc es correcto y est actualizado. a Las pginas estn numeradas. a a Las cabeceras y pies de pgina son correctos. a

5 6 7

P. Snchez (MATESCO) a

Elaborar Informes

13 / 16

Exposicin o

Fases de Elaboracin de un Informe Tcnico o e

1 2 3 4 5 6

Proceso de Bsqueda de Informacin u o Evaluacin y S o ntesis de las Fuentes Estructuracin y Adecuacin del Informe a sus Objetivos o o Redaccin o Edicin y Entrega/Publicacin o o Exposicin o

P. Snchez (MATESCO) a

Elaborar Informes

14 / 16

Exposicin o

Exposicin o

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 presentacin. o Hablar de forma pausada y con convencimiento. Trasmitir por qu el trabajo es importante sin entrar en excesivos e detalles tcnicos. e

P. Snchez (MATESCO) a

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. Snchez (MATESCO) a Elaborar Informes 16 / 16