Guía para la identificación del código

[[Nombre de la institución]]
Guía para la identificación del código
[[fecha]]
Versión 1.0
Guía para la identificación del código
Versión 1.0
[[Autor]]
[[fecha]]
Información del documento
Título
Identificador
Guía para la identificación el código
Versión
1.0
Archivo
Guía identificación del código.doc
Autor
Fecha
Estado
Aprobación del documento
Gerente Técnico
<firma>
<fecha>
<firma>
<fecha>
<firma>
<fecha>
<firma>
<fecha>
<nombre>
[[Responsable de SCM]]
<nombre>
[[cargo/posición]]
<nombre>
[[cargo/posición]]
<nombre>
Registro de cambios
Nro. de
cambio
Fecha
Tipo(1)
Descripción del cambio
Autor
Nro. de
petición
(1) A: Agregar – M: Modificar – E:Eliminar
1
Guía para la identificación del código
Versión 1.0
[[Autor]]
[[fecha]]
Tabla de Contenidos
1
INTRODUCCIÓN .............................................................................................................................. 3
1.1
1.2
1.3
2
PROPÓSITO .................................................................................................................................... 3
DESCRIPCIÓN DEL DOCUMENTO .................................................................................................... 3
GLOSARIO DE TÉRMINOS ............................................................................................................... 3
DESCRIPCIÓN DEL PROCESO ..................................................................................................... 4
2.1
DEFINICIÓN ................................................................................................................................... 4
2.2
ETAPAS ......................................................................................................................................... 4
2.2.1 Selección de los ítems ............................................................................................................... 4
2.2.2 Designación de los ítems de software ....................................................................................... 5
2.2.3 Descripción de los ítems ........................................................................................................... 5
2
Guía para la identificación del código
Versión 1.0
1
1.1
[[Autor]]
[[fecha]]
Introducción
Propósito
El objetivo de la presente guía es orientar la definición de un procedimiento de identificación del
código en las diferentes áreas de una institución informática. El presente documento está
especialmente dirigido al responsable de las tareas de SCM.
1.2
Descripción del documento
Capitulo 1 Introducción: provee una visión general sobre los contenidos y objetivos del
documento. Además, entrega las definiciones y acrónimos utilizados en los capítulos
posteriores.
Capitulo 2 Descripción del proceso: descripción de los pasos requeridos para establecer un
procedimiento de identificación de código.
1.3
Glosario de términos

Ítem de Configuración (CI) Un CI es cualquier documento o artefacto que forma parte del
software, factible de ser desarrollado y evaluado independientemente. Cualquier conjunto de
pasos realizados para alcanzar un objetivo.

Baseline  Un baseline o línea base es uno o más documentos formalmente diseñados y
corregidos en un tiempo específico del ciclo de vida de los ítems de configuración

Control de cambios  El control de cambios es un proceso sistemático para evaluar,
coordinar y decidir sobre los cambios propuestos, así como también, para monitorear la
implantación e incorporación de aquellas modificaciones aprobadas a los baselines y la
documentación asociada. Esta actividad asegura que los cambios sean propuestos,
justificados, evaluados, coordinados, aprobados o rechazados, documentados e incorporados a
un nuevo baseline.
3
Guía para la identificación del código
Versión 1.0
2
[[Autor]]
[[fecha]]
Descripción del proceso
2.1
Definición
En general, el proceso de la identificación de la configuración es la base para un adecuado control
de cambios. Ella comprende la selección, designación y descripción de los ítems de configuración
(CIs). La selección implica clasificar al software en CIs; la designación, definir un esquema de
numeración y denominación que relacione los CIs del software y su documentación; y por último,
la descripción es la documentación de las características funcionales y físicas para cada CI.
En particular, la identificación del software corresponde a la identificación de los archivos que lo
componen, su denominación mediante un esquema definido y la especificación del medio
electrónico que lo contiene.
Cabe destacar que la palabra archivo se utiliza para referenciar las unidades, módulos, rutinas o
subrutinas que forman parte del código.
2.2
Etapas
A continuación se describen los pasos necesarios para establecer la selección, designación y
descripción del software con el propósito de apoyar la definición de un procedimiento de
identificación del software.
2.2.1
Selección de los ítems
Para identificar y seleccionar el software que será sometido a control de configuración, es
necesario:
a) Identificar las categorías del software.
b) Identificar los archivos que componen el software.
2.2.1.1
Identificación de las categorías del software
Los requerimientos de identificación del software variarán según el tipo de categoría, por lo
cual resulta primordial contar con una clara definición de las categorías de software existentes
antes de su identificación.
Algunas categorías aplicables son:




2.2.1.2
Producto de software, corresponde al software como producto final o como una porción
de éste.
Software de firmware, es el software desarrollado para conformar parte de un firmware.
Software comercial, es aquel software existente, provisto y mantenido por un vendedor.
Por ejemplo: sistemas operativos, sistemas de administración de bases de datos,
herramientas para la gestión de un proyecto, etc.
Software de prueba, software desarrollado para apoyar el desarrollo de las pruebas,
incluye la colección de datos de prueba, el ingreso de los datos, la ejecución, la captura de
las respuestas ante las pruebas, etc.
Identificación de los ítems de software
Una vez definidas las categorías del software, se debe establecer los tipos de archivos
asociadas a ella de modo de facilitar la selección de los ítems en proyectos similares.
4
Guía para la identificación del código
Versión 1.0
[[Autor]]
[[fecha]]
Para ello es útil establecer el proceso de implementación (construcción) asociado a una
categoría del software. La idea es identificar dentro del proceso los tipos de ítems (archivos)
representativos de la categoría.
La implementación debe definirse en términos de entradas, tareas, ambiente de desarrollo, y
salidas. Por ejemplo, la entrada puede ser código fuente que según ciertas condiciones y bajo
cierto ambiente (compilador) es convertido en un ejecutable o en código objeto. Luego, los
ítems de software en este caso son el código fuente, el ejecutable o el código objeto.
Este proceso también es aplicable al nivel de un proyecto de desarrollo de software específico
2.2.2
Designación de los ítems de software
La designación de los archivos comprende la definición de un esquema de numeración y
denominación. Para ello es necesario determinar:
a) Un esquema de identificación de los archivos
b) Un esquema de identificación de los medios de almacenamiento.
2.2.2.1
Identificación de los archivos
Los archivos pueden ser descritos en términos del tipo de archivo, el proceso que generó el
archivo y el ambiente de desarrollo, en particular, el sistema operativo. Esto define un esquema
de identificación de tres campos:



Nombre del archivo
Tipo de archivo (Por ejemplo, FORTRAN, C, C++)
Número de versión
La forma en que se denominen estos campos y en la cual se conjuguen debe ser definida por
cada institución manteniendo presente los tipos de archivos identificados por categoría.
2.2.2.2
Identificación de los medios de almacenamiento
Los diferentes archivos del software son almacenados en diferentes medios, lo que implica
necesariamente la necesidad de establecer un esquema de denominación de estos medios.
En general, cada medio debe ser identificado y descrito considerando los siguientes puntos:






2.2.3
La fecha en que se realizó la copia.
Especificación técnica del medio de almacenamiento.
El nombre o el identificador de los archivos que contiene.
El número de copias que almacena.
El nombre de la organización y del proyecto.
El identificador del template que describe la versión del código almacenada.
Descripción de los ítems
La descripción de los ítems, en el presente caso, abarca la descripción de la versión del código
actual. Esta debe incluir:



Una lista de los de archivos almacenados.
Por cada archivo su identificador y una breve descripción.
La documentación asociada a cada archivo.
5
Guía para la identificación del código
Versión 1.0




[[Autor]]
[[fecha]]
Un esquema y una descripción de la forma en que estos archivos se relacionan y/o
complementan.
Los cambios incorporados en relación con la versión previa.
El estado de estos cambios.
Una breve descripción del impacto operacional de los cambios.
6