Sei sulla pagina 1di 10

,QIRUPH7pFQLFR7HFKQLFDO5HSRUW

'372,$,7
1RYLHPEUH

1RUPDVSDUDOD(ODERUDFLyQGH,QIRUPHV
7pFQLFRVHQHO'HSDUWDPHQWRGH,QIRUPiWLFD\
$XWRPiWLFDGHOD8QLYHUVLGDGGH6DODPDQFD
)UDQFLVFR-RVp*DUFtD3HxDOYR
*XLOOHUPR*RQ]iOH]7DODYiQ
0DUtDGH1DYHORQJD0RUHQR*DUFtD
9LGDO0RUHQR5RGLOOD

Departamento de Informtica y Automtica


Universidad de Salamanca

Revisado por:
Dr. Luis Alonso Romero
rea de Ciencias de la Computacin e Inteligencia Artificial
Departamento de Informtica y Automtica
Facultad de Ciencias - Universidad de Salamanca

Dra. Beln Curto Diego


rea de Ingeniera de Sistemas
Departamento de Informtica y Automtica
Facultad de Ciencias - Universidad de Salamanca

Aprobado en el Consejo de Departamento del 6 de noviembre de 2000


Informacin de los autores:
Dr. Francisco Jos Garca Pealvo
rea de Ciencias de la Computacin e Inteligencia Artificial
Departamento de Informtica y Automtica
Facultad de Ciencias - Universidad de Salamanca
Plaza de la Merced S/N 37008 - Salamanca
fgarcia@gugu.usal.es

Guillermo Gonzlez Talavn


rea de Arquitectura y Tecnologa de Computadores
Departamento de Informtica y Automtica
Facultad de Ciencias - Universidad de Salamanca
Plaza de la Merced S/N 37008 - Salamanca
gyermo@gugu.usal.es

Dra. Mara de Navelonga Moreno Garca


rea de Lenguajes y Sistemas Informticos
Departamento de Informtica y Automtica
Facultad de Ciencias - Universidad de Salamanca
Plaza de la Merced S/N 37008 - Salamanca
mmg@gugu.usal.es

Dr. Vidal Moreno Rodilla


rea de Ingeniera de Sistemas
Departamento de Informtica y Automtica
Facultad de Ciencias - Universidad de Salamanca
Plaza de la Merced S/N 37008 Salamanca
control@abedul.usal.es

Este documento puede ser libremente distribuido.


2000 Departamento de Informtica y Automtica - Universidad de Salamanca.

5HVXPHQ
En este documento se recoge la normativa para la elaboracin, aprobacin y posterior difusin
de los informes tcnicos realizados en el seno del Departamento de Informtica y Automtica de
la Universidad de Salamanca.
Estas normas no pretenden controlar la estructura o los contenidos de dichos informes, sino
establecer unos criterios mnimos de formato para estos informes y, lo que es ms importante,
definir un flujo de trabajo con las distintas fases desde su elaboracin hasta su publicacin en el
sitio ZHE del Departamento.

$EVWUDFW
In this document the rules for creation, approval and publication of technical reports produced at
the Computer Science and Automation Department of the University of Salamanca are
presented.
These rules are not intended to control the contents or the structure of these reports, but to
establish a minimum set of format criteria for them and, what is more important, to define a
workflow with every stage from their creation to their publication in the Department web site.

'372,$,7

L

7DEODGH&RQWHQLGRV

LL



,QWURGXFFLyQ BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 



1RUPDVGHIRUPDWR BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 


)RUPDWRGHOGRFXPHQWR BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 



(VWLORVGHIRUPDWR BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 



%LEOLRJUDItDBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 



1RPEUHV\IRUPDWRVGHORVILFKHURV BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 



&LFORGHYLGDGHXQLQIRUPHWpFQLFRBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 



5HIHUHQFLDV BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB 

'372,$,7



,QWURGXFFLyQ

Los informes tcnicos son un tipo de documento tcnico ampliamente reconocido por
Departamentos y Grupos de Investigacin tanto nacionales como internacionales.
La tipologa y contenidos de este tipo de documentos son extremadamente diversos,
pudiendo contener desde el estado del arte de un tema concreto al registro de resultados dentro
de un determinado proceso de investigacin; y todo ello sin las limitaciones propias de una
publicacin en una revista o en las actas de un congreso.
Ms interesante es destacar lo que los informes tcnicos pueden aportar al Grupo de
Investigacin que los elabora: PHWRGRORJtD GH WUDEDMR, de forma que los resultados obtenidos
vayan quedando plasmados, lo que es especialmente til en el caso de los nuevos
investigadores; EDVH SDUD SXEOLFDFLRQHV HQ UHYLVWDV \ FRQJUHVRV, siendo un importante apoyo
escrito para la creacin de artculos ms elaborados y precisos, adems de constituir una base de
auto referencia en los nuevos trabajos; UHJLVWUR GH WUDEDMR HQ SUR\HFWRV VXEYHQFLRQDGRV,
constituyendo un valioso material que aportar en los informes finales de los mismos;
SUHVHQWDFLyQSDUDRWURV*UXSRVGH,QYHVWLJDFLyQ, al ser documentos pblicos y accesibles por
Internet se convierten en tarjetas de presentacin para otros grupos.
Con el fin de garantizar la calidad de estos informes tcnicos y una uniformidad mnima en
todos ellos se ha elaborado un conjunto de normas bsicas de formato y se ha definido un flujo
de trabajo que rige el ciclo de vida de un informe tcnico desde su creacin hasta su publicacin
en las pginas ZHE del Departamento.
El resto del documento se organiza como sigue: en la segunda seccin se abordan los
requisitos de formato, stos sern los mnimos para conseguir unos documentos con una
apariencia similar, no entrando en disquisiciones sobre la estructura del informe o sobre el estilo
de redaccin; temas que se encuentran ampliamente tratados por ejemplo en [1,2]. En la tercera
seccin se define el flujo de trabajo para la obtencin de un informe tcnico validado y
publicado en Internet; este flujo de trabajo establece tanto las fases del ciclo de vida de un
informe tcnico como los productos intermedios que se irn obteniendo en el devenir de las
mismas.



1RUPDVGHIRUPDWR

El formato de un documento tcnico es algo que a priori no parece un aspecto demasiado


importante. Sin embargo de cara a obtener un conjunto de documentos de apariencia uniforme
es imprescindible fijar un conjunto de normas de estilo que faciliten esta labor con
independencia de la herramienta de edicin que se elija para su creacin.
Estas normas se van a dividir en las siguientes categoras:

Formato del documento

Estilos de formato

Bibliografa

Nombres y formatos de los ficheros

 )RUPDWRGHOGRFXPHQWR
Para la creacin de informes tcnicos se utilizar una configuracin de pgina basada en papel
A4, con todos los mrgenes de 3 cm.
Cualquier informe tcnico contar con cuatro partes bien diferenciadas:



1RUPDVSDUDOD(ODERUDFLyQGH,QIRUPHV7pFQLFRV

La portada

Los crditos

El resumen

La tabla de contenidos

Los contenidos

2.1.1 La portada
La portada de cualquier informe tcnico creado en el seno del Departamento de Informtica y
Automtica de la Universidad de Salamanca debe seguir un patrn de definicin tal que d
uniformidad al conjunto de documentos creados bajo este tipo de documento.
Debe ser la primera pgina del informe, no contando con ningn encabezado, pie de pgina
o nmero de pgina.
La estructura de la portada se puede apreciar en la Figura 1.

)LJXUD)RUPDWRGHODSRUWDGD

El informe queda identificado por tres lneas alineadas a la derecha. La primera de ellas
indica el tipo de documento (Informe Tcnico Technical Report). En la segunda aparece el
identificador asignado al informe tcnico una vez aprobado, que ser nico para cada
documento de este tipo. Por ltimo, en la tercera, se incluye el mes y el ao de la aprobacin del
informe.
El identificador de un informe tcnico aprobado est compuesto por cuatro campos, como
se aprecia en la Figura 2.

'372,$,7



*DUFtDHWDO

'372,$,7$$$$111
GtJLWRVSDUDHOQ~PHURGH,7
FRPHQ]DQGRFDGDDxRHQHO
GtJLWRVSDUDHODxRGHFUHDFLyQ
7LSRGHGRFXPHQWR,QIRUPH7pFQLFR
'HSDUWDPHQWRGH,QIRUPiWLFD\$XWRPiWLFD
)LJXUD,GHQWLILFDGRUGHXQLQIRUPHWpFQLFR

Mientras que el informe tcnico no est aprobado llevar un identificador temporal igual
para todos: '372,$,7%255$'25.
El ttulo ir centrado con caracteres en negrita.
Posteriormente irn tambin centrados y en negrita, aunque con un tamao de fuente ms
pequeo, los nombres y apellidos de los autores del informe por orden de firma.
Cerrando la portada se identifica el organismo donde se ha desarrollado el informe, para lo
que a continuacin, y al mismo nivel, se emplazan el logotipo del Departamento de Informtica
y Automtica de la Universidad de Salamanca y el escudo de esta Universidad; tras lo que se
ponen explcitamente los nombres del Departamento y de la Universidad centrados.

2.1.2 Los crditos


En la segunda pgina del informe, y sin ningn tipo de encabezado o pie de pgina, se incluir
la informacin relevante sobre la creacin, aprobacin y subvencin del informe tcnico.
Abriendo la pgina de crditos se incluirn los datos de los dos doctores ajenos a la
creacin del informe que han revisado el mismo para su aprobacin por el Departamento. De
ambos se indicar el nombre, el rea de Conocimiento, el Departamento y la Universidad a la
que pertenecen.
Posteriormente se indicar la fecha de aprobacin en Consejo de Departamento.
A continuacin, y por orden de firma, se incluir toda la informacin relativa a los autores
del informe, a saber: nombre, rea de Conocimiento, Departamento, Facultad o Centro al que se
encuentran vinculados, Universidad o Empresa, direccin postal y direccin de correo
electrnico.
Despus, si fuera apropiado, se indica bajo qu proyecto se ha financiado la investigacin
que ha dado lugar al informe.
Por ltimo, se indica el carcter pblico del documento y que la propiedad intelectual del
mismo pertenece al Departamento de Informtica y Automtica de la Universidad de
Salamanca.

2.1.3 Resumen
El informe contar con un resumen en espaol y en ingls con la longitud que los autores
estimen oportuno en cada caso. Si la extensin no es demasiado corta cada uno de los
resmenes comenzar en una pgina diferente sin encabezados pero con un pie de pgina que,
bajo una lnea horizontal para las pginas impares presente el identificador del informe tcnico
alineado a la izquierda y el nmero de pgina en nmeros romanos en minscula alineado a la
derecha (comenzando con el nmero i) y al contrario para las pginas pares (nmero a la
izquierda e identificador a la derecha).



'372,$,7

1RUPDVSDUDOD(ODERUDFLyQGH,QIRUPHV7pFQLFRV

2.1.4 La tabla de contenidos


El informe tcnico contar con una tabla de contenidos que recoja los ttulos de los apartados
hasta un tercer nivel.
Podrn existir opcionalmente tablas de figuras, cuadros y tablas.
Las pginas no tendrn encabezado y los pies de pgina sern los mismos que en el
resumen, continuando la numeracin en nmeros romanos en minscula.

2.1.5 Los contenidos


En la siguiente pgina impar despus de la tabla de contenidos comenzar el desarrollo del
cuerpo del informe.
La primera pgina de esta seccin no llevar encabezados y como pie de pgina incluir
slo el nmero de pgina centrado y entre guiones. Para numerar las pginas se utilizarn
nmeros arbigos desde el nmero 1, que corresponder a esta pgina.
Las pginas pares e impares siguientes tendrn encabezados y pies de pginas diferentes.
En las pginas pares el encabezado ser el ttulo del informe tcnico alineado a la izquierda
sobre una lnea horizontal de margen izquierdo a margen derecho y el pie de pgina vendr bajo
una lnea horizontal de las mismas dimensiones, con el identificador del informe tcnico
alineado a la izquierda y el nmero de pgina en nmeros arbigos alineado a la derecha.
En las pginas impares el encabezado estar formado por una referencia a los autores
alineada a la derecha, sobre una lnea de las mismas caractersticas que las anteriormente
utilizadas. La referencia a los autores se har de la siguiente manera: si hay un nico firmante
aparecern las iniciales del nombre y su primer apellido; si los firmantes son dos aparecern el
primer apellido de cada uno separado por la conjuncin copulativa \ o DQG dependiendo del
idioma elegido para la redaccin del informe tcnico; si el nmero de firmantes es superior a
dos aparecer el primer apellido del primer firmante seguido de HW DO. En el pie de pgina
aparecer el nmero de pgina alineado a la izquierda y el identificador del informe alineado a
la derecha bajo la consiguiente lnea horizontal.

 (VWLORVGHIRUPDWR
Como estilo normal de escritura se recomienda la utilizacin de un tipo de letra Times o similar
con tamao de 11 puntos y justificacin completa de los prrafos. El primer prrafo de cada
apartado o subapartado no tendr sangra alguna, mientras que el resto de prrafos tendrn una
sangra de primera lnea de 0,75 cm.
La separacin entre dos prrafos consecutivos debe ser aproximadamente de 6 puntos, no
recomendndose la utilizacin de la introduccin del salto de lnea para conseguir dicha
separacin.
Los ttulos de los apartados se destacarn de una forma especial y seguirn un esquema
numerado que facilite su localizacin desde el ndice y su referencia en el cuerpo del texto. No
se recomienda un nivel de anidamiento superior a tres en los ttulos.
Las figuras, tablas y cuadros deben acompaarse de una etiqueta que los identifique como
tales, junto a un texto que describa el elemento adjunto, esto permite mantener referencias
cruzadas a dichos objetos (se aconseja utilizar los mecanismos adecuados para gestionar
automticamente este apartado). Se debe tener un estilo comn para todos los elementos.
Otro estilo que se debe observar es el de las notas al pie de pgina. Se recomienda un
tamao de letra de 9 puntos.

'372,$,7



*DUFtDHWDO

Los encabezados y pies de pgina compartirn el mismo estilo, recomendndose un tamao


de letra de 9 puntos con formato negrita.

 %LEOLRJUDItD
Como en cualquier documento tcnico, las referencias bibliogrficas son de suma importancia,
tanto como fuente de ampliacin de conocimientos adems de como medio de justificar los
contenidos del informe. As, debe cuidarse que las citas bibliogrficas que aparecen en el texto
tengan sus correspondientes entradas en el apartado de referencias bibliogrficas, apartado que
por otra parte se recomienda que sea siempre el ltimo del informe.
Se deja libertad para la eleccin del estilo de formato de referencias bibliogrficas, siempre
y cuando se utilice de forma coherente en todas las entradas. Como ejemplos se van a citar dos
casos extremos ampliamente utilizados: el estilo ACM (donde la cita aparece como un nmero
entre corchetes) o el estilo Apalike (que ofrece una mayor informacin sobre autores y ao de
publicacin).

 1RPEUHV\IRUPDWRVGHORVILFKHURV
Mientras que el informe tcnico est en fase de creacin el nombre del fichero o ficheros
utilizados puede ser el que los autores quieran. Cuando el informe tcnico se encuentre en fase
de evaluacin debe distribuirse a los revisores en un solo fichero cuyo nombre sea:
'372,$,7%255$'253DODEUD6LJQLILFDWLYD
Donde 3DODEUD6LJQLILFDWLYD sea el nombre de uno de los autores o algn trmino acorde
con el ttulo del informe tcnico.
Cuando el informe haya sido aprobado por el Consejo del Departamento el nombre del
fichero que contendr el mismo coincidir con su identificativo, tal y como se explicaba en la
Figura 2:
'372,$,7$$$$111
Por lo que respecta al formato de fichero, los autores pueden utilizar la herramienta de
edicin de textos que prefieran. No obstante, cuando vaya a ser difundido, ya sea para su
evaluacin o para su publicacin definitiva en el servidor web del Departamento, el formato del
fichero ser obligatoriamente el propuesto por el Departamento, actualmente PDF.



&LFORGHYLGDGHXQLQIRUPHWpFQLFR

Un informe tcnico, desde el momento de su elaboracin hasta su publicacin definitiva en el


servidor web del Departamento, itera por un conjunto de etapas con el fin de asegurar un
mnimo de calidad en su elaboracin, que ser reflejo de la calidad del trabajo que se realiza en
el seno del propio Departamento.
Las fases que conforman el ciclo de vida de un informe tcnico son (ver Figura 3):
1. Elaboracin: Los autores elaboran un informe tcnico con los contenidos que crean
oportunos y siguiendo las recomendaciones de formato que se presentan en este
mismo documento. Los idiomas aceptados como vlidos para la redaccin del
informe son el espaol y el ingls (aunque el resumen debe obligatoriamente
figurar en los dos idiomas). La nica restriccin que se indica en esta fase es que al
menos uno de los firmantes del trabajo pertenezca al Departamento de Informtica
y Automtica de la Universidad de Salamanca.
2. Revisin: Una vez que el informe tcnico ha sido elaborado debe ser revisado por
dos doctores que no figuren como autores de dicho informe, elegidos stos por el


'372,$,7

1RUPDVSDUDOD(ODERUDFLyQGH,QIRUPHV7pFQLFRV

grupo de trabajo, buscando siempre la mayor cercana posible al tema abordado.


Los revisores harn llegar sus comentarios a los autores, y se entrar en un ciclo
evaluacin-elaboracin hasta que los dos revisores den por bueno el informe, cosa
que harn en un escrito dirigido al Director del Departamento de Informtica y
Automtica de la Universidad de Salamanca. Los revisores pueden ser ajenos al
Departamento y a la propia Universidad de Salamanca, siempre y cuando tengan el
ttulo de doctor o, excepcionalmente, sean reconocidos expertos en el tema tratado.
3. Aprobacin: Una vez que los revisores han expresado su opinin positiva sobre el
informe, ste debe someterse a su aprobacin en Consejo de Departamento,
asignndosele un nmero nico y correlativo dentro del ao de aprobacin y
empezando por el 001.
4. Preparacin para su publicacin: El informe se modifica para aadir el
identificativo nico y la informacin de los revisores, generndose un fichero PDF
con el mismo nombre que su identificativo.
5. Publicacin: En el servidor web del Departamento se crear un rea donde se
alojarn los informes tcnicos realizados en el Departamento de Informtica y
Automtica de la Universidad de Salamanca. Las nicas restricciones que se
imponen a este lugar web es que sea pblico, es decir, que los documentos puedan
ser descargados por cualquiera que est interesado, y que se organicen por aos, tal
y como sucede en muchas otras Universidades y Organizaciones (como por
ejemplo en el SEI [3]). En funcin del volumen de informes generados puede
estudiarse la implantacin de una biblioteca digital para la gestin de los mismos.
1.
Elaboracin
2.
Revisin
3.
Aprobacin
4.
Preparacin
para publicacin

5.
Publicacin

)LJXUD&LFORGHYLGDGHXQLQIRUPHWpFQLFR



5HIHUHQFLDV

>@ /HYLQH/LQGD3HVDQWH/LQGD+DQG'XQNOH6XVDQ%7HFKQLFDO:ULWLQJIRU6RIWZDUH
(QJLQHHUV. Curriculum Module, SEI-CM-23, Software Engineering Institute. Carnegie
Mellon University, Pittsburgh, PA 15213 (USA). November, 1991.
>@ /L 9LFWRU 2 . +LQWV RQ :ULWLQJ 7HFKQLFDO 3DSHUV DQG 0DNLQJ 3UHVHQWDWLRQV. IEEE
Transactions on Education, 42(2):134-137. May, 1999.
>@ 6RIWZDUH(QJLQHHULQJ,QVWLWXWH. Web Site. http://www.sei.cmu.edu.

'372,$,7



Potrebbero piacerti anche