como estructurar un informe tecnico

Upload: rueckseiteamatos

Post on 05-Apr-2018

218 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/2/2019 Como Estructurar Un Informe Tecnico

    1/2

    EstructurarInformes

    IngenieradelSoftwareII

    FacultaddeCiencias

    Febrero2010

    4IngenieraInformtica

    UniversidaddeCantabria

    1

    CMOESTRUCTURARUNINFORMETCNICOCOMOUNVERDADEROINGENIERO

    1. IntroduccinElpresentedocumentocontieneunabrevedescripcinacercadecmoestructuraruninforme

    tcnicoycmoredactarlaintroduccindelmismoconelrigor,laprecisinylacalidadquese

    lesuponeaunIngenieroSoftware.

    2. Estructuradeuninformetcnico.Uninformetcnicosuelepresentar,salvocircunstanciasadicionales,lasiguienteestructura:

    (1) Resumen.Nomsde200palabrasdescribiendoelcontenidodeltrabajo.(2) Introduccin.Nomsdede2pginasdetallandombito,objetivosyresultadosdel

    trabajo.

    (3) Contenido.Tantas secciones comohagan faltaparaexplicar los contenidos tcnicosdeltrabajo.Sevalorarcapacidaddesntesis,precisinenelusodellenguaje,facilidad

    deseguimientode laexposicinycompletitud.Sevalorarespecialmentequetodas

    las secciones seencuentrenperfectamente ligadas, tenganunobjetivo claro y cada

    prrafoenellascontenidosirvaparaelcumplimientodedichoobjetivo.

    (4) Conclusiones.Deberesumir lospuntosfundamentalesdeltrabajoyservirdesntesisdeltrabajoaaquellapersonainteresadaeneltrabajo.

    (5) ApndiceMetodologa.Especialmenterelevanteentrabajosacadmicosoinformestcnicos 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

    seguidopara laelaboracindel trabajoSe suelevalorarprincipalmenteque sehaya

    seguido un proceso sistmico y/o cientfico. Debern citarse todas las fuentes

    consultadas,tantolasdescartadascomolasusadasparalaelaboracindeltrabajo,as

    comolaraznparadichaaceptacinorechazo.

    3. Redactarunaintroduccinparauninformetcnico.La

    introduccin

    de

    cualquier

    documento

    es

    la

    parte

    ms

    delicada

    del

    mismo.

    La

    introduccin

    y

    elresumenson loprimeroquese leen,ydesucalidaddependerquecaptemosal lectory

    contineconlalecturadelmismo.Inclusoenelcasodondeellectorestobligadoacontinuar

    con la lecturadeldocumento,unabuena introduccinayudaraqueel lector realicedicha

    lecturaconintersyatencin;ynoporsimplecompromisodemanerasuperficial.

    Por tanto, en una introduccin debemos cautivar al lector. Para ello, suele dar resultados

    seguirunesquemacomoelqueseesbozaacontinuacin:

    (1) Descripcindelmbitodeldocumento.Definicionesgenerales.Porejemplo,sielinforme

    es

    sobre

    una

    nueva

    tcnica

    de

    gestin

    de

    costos

    en

    proyectos

    software,

    deberamosempezardiciendoLagestindecostesenproyectos(software)tratade

  • 8/2/2019 Como Estructurar Un Informe Tecnico

    2/2

    EstructurarInformes

    IngenieradelSoftwareII

    FacultaddeCiencias

    Febrero2010

    4IngenieraInformtica

    UniversidaddeCantabria

    2

    estimardeformalomsprecisaposibleelcostetotaldeproduccindeunsistema

    software.

    (2) Paraques relevantedichombito.Porqudeberael lector seguir leyendo sobredicho

    mbito.

    Se

    suelen

    proporcionar

    ejemplos

    ycitar

    fuentes

    que

    confirme

    que

    esos

    ejemplos no son inventados. Por ejemplo, Se ha identificado que las mayores

    prdidaseconmicasenproyectos softwareenosltimosaos tienen suorigenen

    estimaciones imprecisas y/o demasiado optimistas del coste de proyectos software

    (Fulano&Mengano,2008).

    (3) Sobre qu parte de este mbito trata este documento en concreto. Centramos elmbitodenuestrodocumento.Porejemplo,Elpresenteinformedescribeunatcnica

    derecienteaparicinparalaestimacindeproyectossoftwaredentrodeldominiode

    laspajarerasylosasadoresdepollos.

    (4) Culeselobjetivodeestedocumento.Sisetratadeunartculode investigacin,sedebe 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

    incertidumbreexistenteen lastcnicasactualesdeestimacinsoftwareenun10%.

    Enamboscasos,en laseccindeconclusionesdeberemosargumentarcmo sehan

    cubierto estos objetivos brevemente. Ejemplo para el primer caso: 100 personas

    siguieronestadieta,mientrasqueotras100personasno lasiguieron.Ambosgrupos

    depersonas

    fueron

    sometidos

    adiferentes

    esfuerzos

    fsicos

    prolongados.

    A

    continuacin medimos la cantidad de acido lctico acumulado en cada grupo,

    observandounareduccinmediadel30%enaquellaspersonasquehabaseguido la

    dieta descrita en este documento. Ejemplo para el segundo caso: La tcnica de

    Konigashi y Yakamuraha sido aplicada en diversos proyectos software con notable

    xito.Mereceespecialmencinel casode lapajareraEulalio,dondeelerroren la

    estimacin de costes fue inferior al 0.2%, mientras que usando las tcnicas

    tradicionalesdichoerrorsehaestimadodeentreel5%yel15%.

    (5) Breveresumendelprocedimientoseguidoparaelaborareltrabajo.Debedarconfianzaenqueelprocesoseguidoparalaelaboracindelinformehasidounprocesoserioylo

    quese

    describe

    no

    es

    lo

    primero

    que

    se

    le

    ha

    ocurrido

    al

    autor

    olo

    primero

    que

    ha

    encontradoporinternet.

    (6) Estructura del documento. Describe brevemente el contenido de cada seccin delpresenteinforme.LonormalesusarfrasescomoTrasestaintroduccin/EnAdelante,

    este documento/informe se estructura como sigue/tal como se describe a

    continuacin.

    PabloSnchezBarreiro