Ejemplo de Documentacin Tcnica Configuration Management Reglas & Guias

Index

Introduccin Arborescencia Por PM y tipo de Documentacin Estructura Oficina Tcnica

Gestin y System Engineering Estructura Subsistema (WP) Espacio Compartido Repositorio Espacio Oficial

Estructura Delivery Office

Estructura PM Espacio compartido Estructura Gestin Repositorio Espacio Oficial

Index (cont.)

Acceso a Repositorio de Documentos Navegacin en Repositorio de Documentos Reglas de uso Reglas de Evolucin
Versiones menores (borrador) Versiones Mayores (Oficiales)

Introduccin
Objetivos
Crear una arborescencia estructurada en base a un criterio lgico y bien definido que permita un manejo intuitivo del repositorio de la documentacin. Fomentar el uso de Repositorio de Documentos como herramienta de Gestin de la documentacin Hacer del conocimiento de todos los actores del proyecto, la organizacin de la Documentacin en el Repositorio de Documentos para facilitar la consulta, uso y explotacin de la Documentacin a travs de la herramienta.

Arborescencia de nivel 1 y nivel 2

Delivery Office Administracin de la Oficina de Delivery Instalacin de X (roll out) Construccin de Y (roll out) Mantenimiento Capacitacin Pruebas de Fabrica FAT Pruebas en Sitio PAS Control del Repositorio de Documentos Oficina Tcnica Administracin del CTO Ingeniera de Sistemas SS-LAN SS-NOC/ROC SS-SOC SS-Almacenamiento SS-XX SS-YY

Niveles en la Oficina Tcnica

Estructura organizada en base a Sub sistemas Proyectos
Telecomunicaciones Sistemas
Correo Electrnico Directorio Activo Repositorio de Documentos

Mantenimiento Centros Operativos de Red Centros Operativos de Seguridad ETC

Estructura de cada Subsitema

00 10 20 21 22 Administracin del Sub-sistema
Gestin del Subsistema (PKI, Planeacin, etc.) Private Work Space by subsystem Documents of the PE (SSDD, TDS, ICD, etc) Bill of Quantity Docs by site (BoQ) Production Docs (VDD, FAB, Confs), Version managment, detailled configurations, manufacture docs) Installation and support Docs (INS, cableado, plans ) Internal Test (STDs/STRs pre-FAT FAT) General documentation, manufacturer Manuals (DOC standard, SUMs, CLICs,) Technical Specs for subcontrator (ST)

Trabajo Estudios

BoQ Produccion

24 26 27

Instalacin y Mantenimiento

Pruebas Manuales

28 29

ST Espec. Tecnica

SOW Espec. Proveedor - Scope Of Work (SOW)

Tipos de Documentos
SSS Documento general que describe las exigencias del sistema y existe;
Un SSS para PE por cada fase del proyecto

SSDD Documento de diseo sistema/subsistema y existe;

Un SSDD general para cada fase del proyecto Un SSDD por cada subsistema para cada Fase (SSDD-IT, SSDD-SW, etc..)

ICD Documento de descripcin de las Interfaces y existen:

Un ICD0 para PE Fase1 Un ICD por cada Interface identificada por tipo de sito, es decir, los C2, el C4i, el C2M, etc..)

OCD Documento de descripcin del Concepto de Operacin y existe;

Un OCD para PE fase 1 Un OCD para PE fase 2

CDRL Listado de la documentacin y existe

Un CDRL general en archivo excel con la totalidad de los docuemntos Un CDRL para PE Fase1 en formato word (extracto del CDRL general) Un CDRL para PE Fase 2 en formato word (extracto del CDRl general) UN CDRL AsBulit por sitio en formato word (extracto del CDRL general)

Tipos de Documentos (Cont.)

TDS Documento que contiene las especificaciones tcnicas del producto con la configuracin u opciones a suministrar. Se anexan al documento las fichas tcnicas y/o los brochures del fabricante. Existen documentos TDS para cada producto ofertado, estos documentos forman parte de la documentacin del Proyecto Ejecutivo PE HDD Documento que contiene la descripcin detallada o de diseo (planos, esquemas, diagramas) del producto propuesto. En general este documento podra servir de base para fabricar o desarrollar un producto especfico. Existen documentos HDD a nivel de cada subsistema, en caso haber diseos diferentes por tipo de sitio o sitio, entonces existira un HDD para cada sito. Pueden existir documentos tipo HDD-Conf que describen una configuracin especifica de un producto, pudiendo existir uno para cada sitio si as es requerido. Estos documentos forman parte del Proyecto Ejecutivo (PE) y son puestos al da como parte de la documentacin Asbuid. BoQ Documento (tabla) que contiene la Cantidad y distribucin de los productos ofertados. Existe docuemntos BoQ por cada subsistema y por cada sitio Estos documentos forman parte del PE y son puestos al da como parte de la documentacin AsBuid Estos documentos son la referencia para la generacin de los documentos FCO.

Tipos de Documentos (Cont.)

VDD Documento que contiene la descripcin de la versin o versiones de un software o conjunto de software liberado. Indica las mejoras o correcciones respecto a una versin previa, as como los problemas conocidos. Existe un documento VDD por cada producto Software a gestionar (aplicativos, COTS,) FAB (FABD para cmara) Documento que contiene la descripcin detallada para la fabricacin o ensamblado de un producto especifico, por ejemplo FABD-cmara-Domo, detalle de armado del conjunto cmara tipo Domo. Este documento, si aplica, sirve de complemento al documento HDD. INS Documento que describe el procedimiento de instalacin y/o configuracin de un producto, en tratndose de un documento del fabricante, este puede contener tambin las recomendaciones de Mantenimiento o inspeccin (monitoreo de parmetros). Este documento forma parte de la documentacin Asbulid para los productos que aplica DOC Documento cobertura que rene los documentos standard de un producto proporcionados por el fabricante, tales como, manuales, instructivos, Notas tcnicas, etc Estos documentos forman parte de la documentacin AsBuild

Tipos de Documentos (Cont.)

CLIC Documento que agrupa los Certificados y Licencias de los productos entregados por los proveedores o fabricantes. Existe documentos CLIC por cada producto (subsistema) y por cada Sitio. Estos documentos forman parte de la documentacin Asbuild SUM Documento que describe la manera de operar un aplicativo o subsistema producido o personalizado por La Empresa. Por ejemplo SUM-Sistema X/Sistema Y, es el manual del usuario del aplicativo Sistema X/Sistema Y desarrollado por La Empresa. Se genera un documento SUM por cada Aplicativo desarrollado o personlizado (como Sistema de Vigilancia) por La Empresa Este es un documento general que se aplica a todos los sitios Este documento tambin se usa como referencia para generar los soportes de los cursos. Este documento forma parte de la documentacin Asbuid. ST Documento que describe a detalle una especificacin tcnica generalmente de un servicio o producto a subcontratar y es un referencia para solicitar cotizaciones. Este es un documento que se entrega a un proveedor y no al Cliente. Este documento forma parte del contrato asignado a un proveedor SOW Documento que describe los alcances de un servicio a subcontratar. Este documento se genera para acotar (limitar) los trabajos del subcontratista regidos bajo un contrato Este documento al igual que el ST forma parte del contrato asignado a un proveedor

Tipos de Documentos (Cont.)

STDs/STRs Documentos de Descripcin (STD) y Resultados (STR) de Pruebas. Los documentos STDs describen todas las pruebas Funcionales de un Equipo o Subsistema de manera general a fin de aplicarse a todos los sitios. Los STD pueden generarse para diferentes tipos de pruebas, tales como; No regresion (STDNR), Internas y exaustivas (STDi), preFAT y FAT (STD-FAT) y en Sitio (STD-SAT). Los documentos STRs son las fichas de pruebas de los STDs aplicadas y llenadas por cada Sitio. Los Documentos STRs son aplicados por <<Delivery>> conjuntamente con el cliente. STD-ESC /STR-ESC Los documentos STDs-ESC son un caso especial ya que contienen fichas de pruebas operacionales a nivel del Sistema Los documentos STRs-ESC son los resultados de la aplicacin del los STDs-ESC para cada Sitio y permiten liberar el sitio en condiciones operacionales.

Tipos de Documentos (Cont.)

ETD/ETR Los documentos ETD/ETR son para pruebas verificacin de inventarios (suministros) de los elementos Hardware o Software (HW o SW) Los documentos ETDs describen las pruebas de verificacin de inventarios de un Elemento (HW o SW) de manera general a fin de aplicarse a todos los sitios. Los documentos ETRs son las fichas de pruebas de los ETDs aplicadas y llenadas por cada Sitio. Cada Documento ETR tiene como anexo su documento FCO (ver a continuacin) ITD/ITR Los documentos ITD/ITR son para pruebas de verificacin de la instalacin de los elementos Hardware o Software de un subsistema. Los documentos ITDs describen las pruebas de verificacin de instalacin de manera general a fin de aplicarse a todos los sitios. Los documentos ITRs son las fichas de pruebas de los ITDs aplicadas y llenadas por cada Sitio. Cada Documento ITR tiene como anexo su documento FCO (ver a continuacin) FCO Los documentos FCO son fichas de Configuracin que contienen el inventario (cantidad y nmeros de serie) de cada elemento (HW o SW). Los FCOs son parte de los ETRs para validacin de los inventarios y son nicos para cada elemento y para cada sitio. Los FCOs son arterializados (si es necesario) y forman parte de los ITRs para validar la ubicacin final de cada elemento para cada sitio.

 Documentacin tcnica
CI + CTD Rev. ZZZ (ej. 47130921-206 Rev. 001)
El nmero CI est asociado al Articulo de configuracin El cdigo CTD indica el tipo de documento , la referencia de los cdigos se consulta en el documento: Code Type Document

Casos particulares
Existe la posibilidad de que algn documento asociados a un CI y tipio definido se tenga que aplicar a un sitio especifico, para estos casos, se seguirn la siguiente regla
CI+CTD+Fich Rev. ZZZ (ej. 47130946-040-001 Rev. 001)

Las Buenas Practicas

Como nombrar un archivo
Privilegiar los nombres cortos Utilizar el campo (parmetro) <<Title>> del documento para precisar el contenido del archivo. No Usar:
Los caracyeres especiales (&,~,#,",',{,(,[,|,`,\,^,@,),],*,%, ) Microsoft trabaja sobre el disfuncionamiento ligado a los caracteres acentuados sur (,,,,, ) et los <<espacios>> , se recomineda no utilizarlos. Los <<espacios >>: remplazarlos de preferencia por guin - o por underscores _ .

NO poner la fecha o el nmero de version como parte del nombre del archivo, esta gestin es realizada por la herramienta. NO renombrar en el el disco duro local archivos que se actulizan en Repositorio de Documentos ya que al subirlo, se cargar como un nuevo archivo

Gracias