CUDI-CDR
RFCMX 1
Categoría: Informativo
Grupo de Seguridad
Abril-2002
M. Farias-Elinos (ULSA)
C. A. Altamirano (UNAM)
J. G. Hernández (UANL)
G. Wolf (UNAM)
M. A. Balderas (UAT)

Convenciones para la documentación

Resumen:
En este documento se definen las convenciones para el desarrollo de la documentación técnica, organizacional y administrativa que sean generados por los miembros de la Corporación Universitaria para el Desarrollo de Internet (CUDI) y que formarán parte de la serie RFCMX dentro de la red de Internet-2 México.

Palabras claves: Internet-2 México, CUDI, Solicitud de Comentarios, Convenciones.


Derechos de Copia
Copyright (C) CUDI-CDR-Grupo de Seguridad (2002). Todos los derechos Reservados
La distribución de este memo no esta limitada.

Tabla de contenido:

1. Introducción
2. Fomato
3. Contenido
4. Evaluación
5. Publicación
6 Datos autores


1. Introducción

El comité de Desarrollo de la Red (CDR) tiene como objetivo primordial el establecer los lineamientos técnicos (hardware y software) que coadyuven al desarrollo de la Internet-2 en México, por lo cual se ve en la necesidad de establecer la serie de Solicitud de Comentarios (Request for Comments) para México (RFCMX) como una documentación técnica y organizacional que definen las especificaciones utilizadas por la red de CUDI tanto en su parte de redes y telecomunicaciones como en las aplicaciones.

La documentación que se incluya en esta serie puede ser producida por cualquier persona, o grupo de personas, siempre y cuando sean parte de alguna institución que sea miembro activo de CUDI, y sea evaluado por el Comité respectivo.

Cabe mencionar que actualmente existen tres comités dentro de CUDI, el CDR, el Comité de Aplicaciones y Asignación de Fondos (CAAF), y el Comité de Membresías (CM).
 

2. Formato

El reporte deberá estar a una columna con tipografía “times new roman” de 12 puntos, con excepción del título principal que será de 16 puntos en negritas; y los títulos de sección que serán de 14 puntos, en itálica, negrillas y con numeración consecutiva.

En la parte superior izquierda de la primera hoja se tendrá:

 CUDI-sss
 RFCMX x
 Categoría: y
 Obsoleta: z
 Grupo de trabajo
donde:
 
sss
especifica el comité en el cual se generó dicho documento, pudiendo ser: CDR (Comité de Desarrollo de la Red), CAAF (Comité de Aplicaciones y Asignación de Fondos) y CM (Comité de Membresías), pudiendo crearse más comités.
x
Es un número consecutivo, el cual estará a cargo del coordinador del grupo de seguridad
y
    Especifica la categoría en la que entra dicho documento, siendo:
      Informativo
      Estándar
      Experimentales
      Especificativo
z
Indica el número de documento anterior al cual esta inutilizando por la actualización que representa el documento generado.
trabajo
Es el nombre del grupo que propone del documento, cabe mencionar que cada Comité esta conformado por grupos de trabajo.
En la parte superior derecha de la primera hoja se tendrá:
Fecha del documento en el formato mes-año
Nombre del o los autores con las siglas de la institución a la que pertenecen


En la parte superior de la primera hoja, deberá de ir el título del documento, seguido de un resumen no mayor a 300 palabras, posteriormente deberá venir la frase palabras clave seguido de los términos claves que se involucran en el RFCMX, no siendo mayor a seis términos.

Enseguida la leyenda:

Derecho de CopiaCopyright © CUDI-sss-grupo de trabajo (año). Todos los Derechos ReservadosLa distribución de este memo no está limitada.

Posteriormente un índice a un nivel, donde el nombre de cada sección refleje el contenido de dicha sección facilitando la búsqueda de la información.

En el extremo superior izquierdo de las siguientes hojas se tendrá:

El nombre del primer autor, si son varios, el nombre del primer autor seguido por las palabras “et. al.”
La palabra RFCMX seguido del número asignado


En el extremo superior derecho de las siguientes hojas se tendrá:

El número de página
Fecha en el formato mes-año


En la parte superior y centrado de las siguientes hojas se tendrá:

El título del documento


En la parte inferior izquierda de las siguientes hojas se tendrá:

La palabra CUDI seguido de las siglas del comité y del grupo de trabajo que propone el documento.


En la parte inferior derecha de las siguientes hojas se tendrá:

La categoría en la que entra dicho documento.


En la última parte, antes de las referencias, deberá incluirse los datos de contacto de los autores, tales como dirección física, Institución, teléfonos, fax, correo electrónico. A dos columnas.
 

3. Contenido

Los objetivos de esta serie son:


El contenido de la documentación puede ser de tipo:

  1. Especificaciones
  2. Implementaciones técnicas
  3. Estándares
  4. Propuestas
  5. Memoria técnica
En el caso de las implementaciones técnicas, se deberá contener una breve explicación de las bases, haciendo referencia a los documentos (libros, artículos en revistas, etc) donde se pueda profundizar más sobre los aspectos teóricos, así mismo contendrá la explicación a las configuraciones utilizadas y los resultados de las pruebas realizadas.

Para el caso de las especificaciones, estándares y propuestas deberán contener las bases formales indicando, a través de las referencias, los documento o estándares de donde se están basando para el desarrollo del documento.

En el resumen deberá contener la importancia, relevancia y aportación del escrito de una manera general, así mismo, el índice estará desglosado a un nivel reflejando las secciones en las que se divide del documento, las palabras claves deberán reflejar la temática del documento.

Cabe mencionar que los RFCMX no están limitados a cuestiones técnicas de la red, sino también involucra el desarrollo de aplicaciones realizadas por las universidades y centros de investigación que aprovechen las bondades y capacidades de la redCUDI.
 

4. Evaluación

Para la publicación del documento es necesario que los autores, miembros de CUDI, hagan llegar al CDR el documento para ser evaluado, para ello el CDR se conforma por:

Para el caso donde los documentos cuyo contenido no tenga que ver con las cuestiones técnicas de la red, dicho documento será enviado al comité respectivo, o en el caso de que el documento tenga que ver con varios comités, se formará un grupo de revisores afines al tema. Los revisores darán si veredicto al CDR quien notificará del resultado, así como de los comentarios que se realicen al documento.
 

5. Publicación

El documento, una vez aprobado, se agregará a los demás documentos generados, publicándose en la dirección http://rfc.cudi.edu.mx/, pudiendo haber otros sitios espejo o alternos, quedando el sitio principal bajo la responsabilidad del grupo de seguridad.

Cada RFCMX múltiplo de 100 se utilizará para tener un pequeño compendio de los RFCMX anteriores que contendrá el número del RFCMX, el primer autor, el título, la fecha y el resumen.

Para la publicación[2] del documento se utilizaran los formatos ASCII, PDF, PS y HTML, siguiendo la siguiente nomenclatura para los nombres de los archivos:

En el caso de los archivos PDF y HTML deberán contener, en los campos específicos de cada formato, las palabras claves y descripción breve del documento, con la intención de facilitar su búsqueda.
 

6. Datos autores
 

Mario Farias-Elinos
Universidad La Salle (ULSA)
Escuela de Ingeniería / Dirección de Posgrado e Investigación
Benjamín Franklin 47
Col. Hipódromo Condesa
México, DF, 06140
Tel: (55) 5278-9539
Fax: (55) 5515-7631
e-mail: elinos@ci.ulsa.mx
Carlos A. Vicente Altamirano
Universidad Nacional Autónoma de México (UNAM)
Dirección General de Servicios de Cómputo Académico (DGSCA)
Centro de Operación de la Red
Circuito Exterior S/N, C.U.
México, DF, 04510
Tel: (55) 5622-8526
e-mail: carlos@antares.noc.unam.mx
José Guadalupe Hernández E.
Universidad Autónoma de Nuevo León (UANL)
Dirección de Sistemas e Informática
Tel: (81) 8329-4040 x 4102
e-mail: josherna@dsi.uanl.mx
Gunnar Wolf
Universidad Nacional Autónoma de México (UNAM)
FES Iztacala
Av. de los Barrios #1
Col. Los Reyes Iztacala
Tlalnepantla, Edo. de México, 59040
Tel: (55) 5623-1118
Fax: (55) 5623-1119
e-mail: gwolf@campus.iztacala.unam.mx
Marco A. Balderas
Universidad Autónoma de Tamaulipas (UAT)
e-mail: workn@mail.ru

Referencias
[1] Reglamento de CUDI.
[2] Postel, J., Reynolds, J., “Instructions to RFC Authors”, RFC 2223, October 1997
 

CUDI-CDR-Grupo de Seguridad Informativo