EstructurarInformes Febrero2010 IngenieradelSoftwareII 4IngenieraInformtica FacultaddeCiencias UniversidaddeCantabria

CMOESTRUCTURARUNINFORMETCNICOCOMOUN VERDADEROINGENIERO
1. Introduccin
Elpresentedocumentocontieneunabrevedescripcinacercadecmoestructuraruninforme tcnico y cmo redactar la introduccin del mismo con el rigor, la precisin y la calidad que se lesuponeaunIngenieroSoftware.

2. Estructuradeuninformetcnico.
Uninformetcnicosuelepresentar,salvocircunstanciasadicionales,lasiguienteestructura: (1) Resumen.Nomsde200palabrasdescribiendoelcontenidodeltrabajo. (2) Introduccin.Nomsdede2pginasdetallandombito,objetivosyresultadosdel trabajo. (3) Contenido. Tantas secciones como hagan falta para explicar los contenidos tcnicos deltrabajo.Sevalorarcapacidaddesntesis,precisinenelusodellenguaje,facilidad de seguimiento de la exposicin y completitud. Se valorar especialmente que todas las secciones se encuentren perfectamente ligadas, tengan un objetivo claro y cada prrafoenellascontenidosirvaparaelcumplimientodedichoobjetivo. (4) Conclusiones. Debe resumir los puntos fundamentales del trabajo y servir de sntesis deltrabajoaaquellapersonainteresadaeneltrabajo. (5) Apndice Metodologa. Especialmente relevante en trabajos acadmicos o informes tcnicos de investigacin donde sea necesario evaluar el proceso seguido para la elaboracin del mismo de cara a evaluar la veracidad, validez y calidad de su contenido. En esta seccin se debe describir de forma breve pero completa el proceso seguido para la elaboracin del trabajo Se suele valorar principalmente que se haya seguido un proceso sistmico y/o cientfico. Debern citarse todas las fuentes consultadas, tanto las descartadas como las usadas para la elaboracin del trabajo, as comolaraznparadichaaceptacinorechazo.

3. Redactarunaintroduccinparauninformetcnico.
Laintroduccinde cualquierdocumentoeslaparte msdelicada delmismo.Laintroducciny el resumen son lo primero que se leen, y de su calidad depender que captemos al lector y contine con lalecturadel mismo.Inclusoenel casodondeellectorestobligadoacontinuar con la lectura del documento, una buena introduccin ayudar a que el lector realice dicha lecturaconintersyatencin;ynoporsimplecompromisodemanerasuperficial. Por tanto, en una introduccin debemos cautivar al lector. Para ello, suele dar resultados seguirunesquemacomoelqueseesbozaacontinuacin: (1) Descripcindelmbitodeldocumento.Definicionesgenerales.Porejemplo,siel informeessobreunanuevatcnicadegestindecostosenproyectossoftware, deberamosempezardiciendoLagestindecostesenproyectos(software)tratade 1

EstructurarInformes Febrero2010 IngenieradelSoftwareII 4IngenieraInformtica FacultaddeCiencias UniversidaddeCantabria estimardeformalomsprecisaposibleelcostetotaldeproduccindeunsistema software. Para qu es relevante dicho mbito. Por qu debera el lector seguir leyendo sobre dicho mbito. Se suelen proporcionar ejemplos y citar fuentes que confirme que esos ejemplos no son inventados. Por ejemplo, Se ha identificado que las mayores prdidas econmicas en proyectos software en os ltimos aos tienen su origen en estimaciones imprecisas y/o demasiado optimistas del coste de proyectos software (Fulano&Mengano,2008). Sobre qu parte de este mbito trata este documento en concreto. Centramos el mbitodenuestrodocumento.Porejemplo,Elpresenteinformedescribeunatcnica de reciente aparicin para la estimacin de proyectos software dentro del dominio de laspajarerasylosasadoresdepollos. Cul es el objetivo de este documento. Si se trata de un artculo de investigacin, se debe comentar claramente qu aspecto del estado actual hemos mejorado. Por ejemplo,ladietapresentadaenesteartculocontribuyeareducirlacantidaddecido lcticoacumuladotrasesfuerzosfsicosprolongados.Sisetratadeuninformetcnico, normalmente se resaltan los mritos alcanzados por otros. Por ejemplo, la tcnica de estimacin de costes propuesta por Konigashi y Yakamura permite reducir la incertidumbre existente en las tcnicas actuales de estimacin software en un 10%. En ambos casos, en la seccin de conclusiones deberemos argumentar cmo se han cubierto estos objetivos brevemente. Ejemplo para el primer caso: 100 personas siguieron esta dieta, mientras que otras 100 personas no la siguieron. Ambos grupos de personas fueron sometidos a diferentes esfuerzos fsicos prolongados. A continuacin medimos la cantidad de acido lctico acumulado en cada grupo, observando una reduccin media del 30% en aquellas personas que haba seguido la dieta descrita en este documento. Ejemplo para el segundo caso: La tcnica de Konigashi y Yakamura ha sido aplicada en diversos proyectos software con notable xito. Merece especial mencin el caso de la pajarera Eulalio, donde el error en la estimacin de costes fue inferior al 0.2%, mientras que usando las tcnicas tradicionalesdichoerrorsehaestimadodeentreel5%yel15%. Breveresumendelprocedimientoseguidoparaelaborareltrabajo.Debedarconfianza enqueelprocesoseguidoparalaelaboracindelinformehasidounprocesoserioylo que se describe no es lo primero que se le ha ocurrido al autor o lo primero que ha encontradoporinternet. Estructura del documento. Describe brevemente el contenido de cada seccin del presente informe. Lo normal es usar frases como Tras esta introduccin/En Adelante, este documento/informe se estructura como sigue/tal como se describe a continuacin. PabloSnchezBarreiro

(2)

(3)

(4)

(5)

(6)