EstructurarInformes Febrero2010 IngenieradelSoftwareII 4IngenieraInformtica FacultaddeCiencias UniversidaddeCantabria

CMOESTRUCTURARUNINFORMETCNICOCOMOUN VERDADEROINGENIERO
1. Introduccin
Elpresentedocumentocontieneunabrevedescripcinacercadecmoestructuraruninforme tcnicoycmoredactarlaintroduccindelmismoconelrigor,laprecisinylacalidadquese 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.Deberesumirlospuntosfundamentalesdeltrabajoyservirdesntesis deltrabajoaaquellapersonainteresadaeneltrabajo. (5) ApndiceMetodologa.Especialmenterelevanteentrabajosacadmicosoinformes 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.Enestaseccinsedebedescribirdeformabreveperocompletaelproceso 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,tantolasdescartadascomolasusadasparalaelaboracindeltrabajo,as comolaraznparadichaaceptacinorechazo.

3. Redactarunaintroduccinparauninformetcnico.
Laintroduccindecualquierdocumentoeslapartemsdelicadadelmismo.Laintroducciny el resumen son lo primero que se leen, y de su calidad depender que captemos al lector y contineconlalecturadelmismo.Inclusoenelcasodondeellectorestobligadoacontinuar 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 dichombito.Sesuelenproporcionarejemplosycitarfuentesqueconfirmequeesos 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 derecienteaparicinparalaestimacindeproyectossoftwaredentrodeldominiode laspajarerasylosasadoresdepollos. Culeselobjetivodeestedocumento.Sisetratadeunartculodeinvestigacin,se debe comentar claramente qu aspecto del estado actual hemos mejorado. Por ejemplo,ladietapresentadaenesteartculocontribuyeareducirlacantidaddecido lcticoacumuladotrasesfuerzosfsicosprolongados.Sisetratadeuninformetcnico, normalmenteseresaltanlosmritosalcanzadosporotros.Porejemplo,latcnicade estimacin de costes propuesta por Konigashi y Yakamura permite reducir la incertidumbreexistenteenlastcnicasactualesdeestimacinsoftwareenun10%. En ambos casos, en la seccin de conclusiones deberemos argumentar cmo se han cubierto estos objetivos brevemente. Ejemplo para el primer caso: 100 personas siguieronestadieta,mientrasqueotras100personasnolasiguieron.Ambosgrupos de personas fueron sometidos a diferentes esfuerzos fsicos prolongados. A continuacin medimos la cantidad de acido lctico acumulado en cada grupo, observandounareduccinmediadel30%enaquellaspersonasquehabaseguidola 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 primeroque ha encontradoporinternet. Estructura del documento. Describe brevemente el contenido de cada seccin del presenteinforme.LonormalesusarfrasescomoTrasestaintroduccin/EnAdelante, este documento/informe se estructura como sigue/tal como se describe a continuacin. PabloSnchezBarreiro

(2)

(3)

(4)

(5)

(6)