Estructurar Informes

Ingeniera del Software II

Facultad de Ciencias

Febrero 2010
4 Ingeniera Informtica
Universidad de Cantabria

CMO ESTRUCTURAR UN INFORME TCNICO COMO UN

VERDADERO INGENIERO
1. Introduccin
El presente documento contiene una breve descripcin acerca de cmo estructurar un informe
tcnico y cmo redactar la introduccin del mismo con el rigor, la precisin y la calidad que se
le supone a un Ingeniero Software.

2. Estructura de un informe tcnico.

Un informe tcnico suele presentar, salvo circunstancias adicionales, la siguiente estructura:
(1) Resumen. No ms de 200 palabras describiendo el contenido del trabajo.
(2) Introduccin. No ms de de 2 pginas detallando mbito, objetivos y resultados del
trabajo.
(3) Contenido. Tantas secciones como hagan falta para explicar los contenidos tcnicos
del trabajo. Se valorar capacidad de sntesis, precisin en el uso del lenguaje, 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
prrafo en ellas contenido sirva para el cumplimiento de dicho objetivo.
(4) Conclusiones. Debe resumir los puntos fundamentales del trabajo y servir de sntesis
del trabajo a aquella persona interesada en el trabajo.
(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
como la razn para dicha aceptacin o rechazo.

3. Redactar una introduccin para un informe tcnico.

La introduccin de cualquier documento es la parte ms delicada del mismo. La introduccin y
el resumen son lo primero que se leen, y de su calidad depender que captemos al lector y
contine con la lectura del mismo. Incluso en el caso donde el lector est obligado a continuar
con la lectura del documento, una buena introduccin ayudar a que el lector realice dicha
lectura con inters y atencin; y no por simple compromiso de manera superficial.
Por tanto, en una introduccin debemos cautivar al lector. Para ello, suele dar resultados
seguir un esquema como el que se esboza a continuacin:
(1) Descripcin del mbito del documento. Definiciones generales. Por ejemplo, si el
informe es sobre una nueva tcnica de gestin de costos en proyectos software,
deberamos empezar diciendo La gestin de costes en proyectos (software) trata de
1

Estructurar Informes
Ingeniera del Software II
Facultad de Ciencias

(2)

(3)

(4)

(5)

(6)

Febrero 2010
4 Ingeniera Informtica
Universidad de Cantabria

estimar de forma lo ms precisa posible el coste total de produccin de un sistema

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
mbito de nuestro documento. Por ejemplo, El presente informe describe una tcnica
de reciente aparicin para la estimacin de proyectos software dentro del dominio de
las pajareras y los asadores de pollos.
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, la dieta presentada en este artculo contribuye a reducir la cantidad de cido
lctico acumulado tras esfuerzos fsicos prolongados. Si se trata de un informe tcnico,
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
tradicionales dicho error se ha estimado de entre el 5% y e l 15% .
Breve resumen del procedimiento seguido para elaborar el trabajo. Debe dar confianza
en que el proceso seguido para la elaboracin del informe ha sido un proceso serio y lo
que se describe no es lo primero que se le ha ocurrido al autor o lo primero que ha
encontrado por internet.
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.
Pablo Snchez Barreiro