Stndares para documentacin.

doc 1
A N E P Instituto Tecnolgico Superior
CONSEJO DE EDUCACION F. Arias L. Balparda
TECNICO PROFESIONAL Gral. Flores 3591 esq.
(Universidad del Trabajo Bvar. Jos Batlle y Ordoez
Del Uruguay) Montevideo, Uruguay









Estndares para
Documentacin



Autor: Instituto Tecnolgico Superior


Personas que colaboraron en la realizacin de este documento:

Brun, Carlos
Ferreira, Rodolfo
Suarez, Gustavo

Octubre de 2003

Stndares para documentacin.doc 2

Objetivo

El objetivo de este documento es establecer estndares para documentar Proyectos que sean realizados en
ITS, con un formato similar, dndole homogeneidad a todo el trabajo realizado, facilitando la tarea de los
Sres. Docentes y aumentando la comprensin del mismo para los lectores.


Alcance

Este estndar se aplicar a todos la documentacin que acompae a los Proyectos a realizar, sin
importar el ao para el cual sean desarrollados, incluyendo las Tecnicaturas correspondientes. Es
decir, que ser aplicable a los Proyectos de 1er. Ao, 2do. Ao y 3er. Ao del BT de
Mantenimiento Informtico as como a la Tecnicatura en Redes y Comunicaciones.

En un futuro, y si fuera considerado de utilidad por los dems BTs por alguna de las dems
dependencias de UTU, podra ser ampliado a los efectos de que cubra todas las posibles
necesidades de documentacin existentes.

Stndares para documentacin.doc 3



Indice


1. Estndares de documentacin ................................................................................ 4
1.1. Formato y Estilos. ................................................................................................. 4
1.2. Documentacin de Procesos y Normas. ............................................................... 5

Bibliografa ..................................................................................................................... 6
Anexo A .......................................................................................................................... 7
Anexo B .......................................................................................................................... 8
Anexo C .......................................................................................................................... 9

Stndares para documentacin.doc 4
1. Estndares de documentacin

A continuacin se especifican los diferentes estndares que se debern
utilizar en la realizacin de los documentos referentes a Proyectos, en el
Instituto Tecnolgico Superior, rea de Informtica.

1.1. Formato y Estilos.
Papel: Tamao A4, de la norma UNIT, correspondiente a 210 mm por 297 mm de tamao,
pudindose tratar de papel fanfold de papel tipo fotocopia, 70 gr, superior, blanco o
super blanco.

Mrgenes: Superior 2.5 cm.
Inferior 2.5 cm.
Derecho 1.5 cm, en anverso.
Derecho 3.5 cm, en reverso.
Izquierdo 3.5 cm, en anverso.
Izquierdo 1.5 cm, en reverso.

Cabezal: 1.25 cm. En el margen superior se colocar sobre el borde derecho Instituto
Tecnolgico Superior. Se debe utilizar el tipo de letra Times New Roman, 10 pto.
Ejemplo:

Instituto Tecnolgico Superior

Pie: 1.25 cm. En el margen inferior se colocar sobre la derecha el nmero de pgina y sobre
la izquierda el Nombre del Documento. Se debe utilizar el tipo de letra Arial 10 pto.
Ejemplo:

Stndares para documentacin.doc 1

Texto: Justificado. Tipo de letra Times New Roman, 12 pto. Si existe un diagrama en el
cuerpo del documento, no debe quedar parte en una hoja y parte en otra. El diagrama
completo, debe quedar en la misma hoja. Entindase por diagrama a tablas, dibujos, y
dems.

Ttulos: Alineado sobre la izquierda, con tamao de letra visiblemente mayor a los subttulos
(Times New Roman 18) en negrita y numerados. No debe quedar un ttulo ubicado al
final de una pgina sino que debe pasarse a la pgina siguiente.

Subttulos: Alineados sobre la izquierda, con tamao de letra visiblemente mayor al texto (Times
New Roman, 16), en negrita. No deber llevar subrayado ni ser cursiva. Indicar el
nmero de subttulo dentro del ttulo. Cuando es un subttulo de otro subttulo, el
tamao de letra ser en orden decreciente hasta llegar al tamao del texto y en negrita
(es decir: 16,14,12).

Interlineado: Simple entre prrafos.
Doble entre ttulos y prrafos
Triple entre final de prrafos y ttulo

Se dispone adems que la escritura texto impreso sea fcilmente legible, por lo tanto deben presentarse
documentos con misma cantidad de lneas y caracteres por lnea.

Stndares para documentacin.doc 5

1.2. Documentacin.
Debe contener las siguientes secciones:

1. Cartula: Con la informacin del contenido incluyendo ttulo del documento,
nombre de archivo, quin lo escribi y dems. Ver Anexo A.

2. Participantes: Con el solicitante del documento: Instituto Tecnolgico Superior, y
una lista alfabtica, por apellido, de todas las personas que
colaboraron en la realizacin del mismo. El tipo de letra, deber ser
Times New Roman tamao 12. Ver Anexo B.

3. ndice: Con los ttulos y subttulos que contenga el documento y sus
nmeros de pgina correspondientes. Ellos deben coincidir
exactamente con los del documento. El tipo de letra del ndice,
deber ser Arial tamao 12. Los ttulos debern aparecer en Negrita.

4. Vocabulario y Simbologa: Definicin del Vocabulario y de la Simbologa utilizada en el
documento tomando en cuenta todo aquello que se separe del Idioma
Espaol puro. Debern considerarse tambin palabras del tipo de
abreviaturas, palabras tcnicas, alias, y otras que se consideren
necesarias de aclarar. Es opcional su realizacin, dependiendo del
contenido y la terminologa utilizada en el documento.

6. Bibliografa: Documentacin que sirve de referencia, base para el estudio o
investigacin para la elaboracin de este material. Las citas
bibliogrficas debern ir ordenadas alfabticamente por nombre del
autor y fecha. La informacin a incluir ser: apellido y nombre del
autor; ao de publicacin, ttulo completo, edicin y editorial (en
este orden). Las direcciones en internet debern ir ordenadas por
autor personal y/o institucional. Ver Anexo C.

7. Anexos: Se incluirn cuando el documento lo requiera a continuacin de la
bibliografa. La numeracin de los mismos se realizar utilizando
letras en orden alfabtico (A, B, ...,y as sucesivamente).




Stndares para documentacin.doc 6
Bibliografa

Universidad ORT Uruguay. 2000.. Pautas para
documentacin.

1995. Norma UNIT-ISO 90013. Directrices para el desarrollo de
manuales de calidad. Instituto Uruguayo de Normas Tcnicas.


1995. Norma UNIT-ISO 9001. Directrices para la redaccin de un
manual de calidad. Instituto Uruguayo de Normas Tcnicas.


Stndares para documentacin.doc 7
Anexo A

Este anexo se refiere a la cartula de los documentos, su contenido y su formato.

La cartula debe contener la siguiente informacin:

1. Organizacin a la cual pertenece el documento.



A N E P Instituto Tecnolgico Superior
CONSEJO DE EDUCACION F. Arias L. Balparda
TECNICO PROFESIONAL Gral. Flores 3591 esq.
(Universidad del Trabajo Bvar. Jos Batlle y Ordoez
Del Uruguay) Montevideo, Uruguay





2. Nombre del documento (ttulo descriptivo), Times New Roman, 48.
Los dems textos de la cartula, salvo donde se especifica en forma explcita, debern
escribirse en Arial 12.

Estndares para
Documentacin



3. Hojas numeradas, todas, incluyendo la cartula
.
4. El ttulo central del documento deber dar una primera idea sobre el contenido del mismo.
Si fuera necesario, se agregar un sub-ttulo.

5. Fecha de vigencia el documento.

6. Nombre del archivo que contiene dicho documento.










Stndares para documentacin.doc 8
Anexo B

Participantes

Autor: Instituto Tecnolgico Superioir


Personas que colaboraron en la realizacin de este documento:

Brun, Carlos
Ferreira, Rodolfo
Suarez, Gustavo

Stndares para documentacin.doc 9
Anexo C

Bibliografa


Schildt, Herbert. 1994. Turbo C / C++
Osborne McGraw-Hill

Amundsen, Michael & Smith, Curtis. 1997. Database Programming with Visual Basic 5
SAMS Publishing