Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
'372,$,7
1RYLHPEUH
1RUPDVSDUDOD(ODERUDFLyQGH,QIRUPHV
7pFQLFRVHQHO'HSDUWDPHQWRGH,QIRUPiWLFD\
$XWRPiWLFDGHOD8QLYHUVLGDGGH6DODPDQFD
)UDQFLVFR-RVp*DUFtD3HxDOYR
*XLOOHUPR*RQ]iOH]7DODYiQ
0DUtDGH1DYHORQJD0RUHQR*DUFtD
9LGDO0RUHQR5RGLOOD
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
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
Estilos de formato
Bibliografa
)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.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
(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
%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
'372,$,7
1RUPDVSDUDOD(ODERUDFLyQGH,QIRUPHV7pFQLFRV
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