Metodologia GTC 199 Documentación de Software

GUÍA TÉCNICA GTC
COLOMBIANA 199
2009-12-16
TECNOLOGÍA DE LA INFORMACIÓN.
DIRECTRICES PARA LA GESTIÓN DE LA
DOCUMENTACIÓN DEL SOFTWARE
E: INFORMATION TECHNOLOGY. GUIDELINES FOR THE

MANAGEMENT OF SOFTWARE DOCUMENTATION
CORRESPONDENCIA: esta guía es una adopción idéntica

(IDT) por traducción, respecto a su
documento de referencia, la norma
ISO/IEC TR 9294:2005
DESCRIPTORES: tecnología de la información;

documentación de software; normas;
procedimientos; recursos.
I.C.S.: 35.080.00
Editada por el Instituto Colombiano de Normas Técnicas y Certificación (ICONTEC)

Apartado 14237 Bogotá, D.C. - Tel. (571) 6078888 - Fax (571) 2221435
Prohibida su reproducción Editada 2009-12-24

PRÓLOGO
El Instituto Colombiano de Normas Técnicas y Certificación, ICONTEC, es el organismo

nacional de normalización, según el Decreto 2269 de 1993.
ICONTEC es una entidad de carácter privado, sin ánimo de lucro, cuya Misión es fundamental
para brindar soporte y desarrollo al productor y protección al consumidor. Colabora con el
sector gubernamental y apoya al sector privado del país, para lograr ventajas competitivas en
los mercados interno y externo.
La representación de todos los sectores involucrados en el proceso de Normalización Técnica

está garantizada por los Comités Técnicos y el período de Consulta Pública, este último
caracterizado por la participación del público en general.
La GTC 199 fue ratificada por el Consejo Directivo del 2009-12-16
Esta norma está sujeta a ser actualizada permanentemente con el objeto de que responda en
todo momento a las necesidades y exigencias actuales.
A continuación se relacionan las empresas que colaboraron en el estudio de esta guía a través
de su participación en el Comité Técnico 31 Ingeniería de Software y sistemas.
GATTACA S.A. PIRÁMIDE ADMINISTRACIÓN DE

INGERSCHOFT INFORMACIÓN LTDA.
KAOME QUASAR SOFTWARE
Además de las anteriores, en Consulta Pública el Proyecto se puso a consideración de las

siguientes empresas:
AGENDA DE CONECTIVIDAD DESARROLLOS TECNOLÓGICOS S.A.

ALIANZA FIDUCIARIA DYNAMIC MODULAR SYSTEM DMS
ALIANZA SINERTIC E-BUSINESS DESTRIBUTION COLOMBIA
ASESOFTWARE LTDA. S.A.
AVANSOFT S.A. EMPRESA DE ENERGÍA DE BOGOTÁ
BANCO CAJA SOCIAL BCSC ESP
BANCO DE LA REPÚBLICA ENTROPÍA LTDA.
C.I. DISAN S.A. ESCUELA COLOMBIANA DE INGENIERÍA
C & G LTDA. ETB
CONSULTAMOS LTDA. EXTRUCOL
COLGRABAR LTDA. FEDERACIÓN NACIONAL DE COMERCIANTES
COMERTECSA LTDA. – FENALCO
CONEXION SISTEMAS LTDA. FEDEGAN
CONSULTORES TECNOLÓGICOS FEDESOFT
ASOCIADOS LTDA. FUNDACION SANTA FE
CONTRALORÍA GENERAL DE LA REPÚBLICA FUNDACIÓN UNIVERSITARIA MARÍA CANO
DAKYA GATTACA S.A.
DELOITTE GBITT
DESARROLLO Y CONSULTORÍA DE SISTEMAS GEOCONSULT
INFORMÁTICOS S.A. GESTION GROUP COLOMBIA LTDA.
GETRONICS LTDA. PIRÁMIDE ADMINISTRACIÓN DE
GRANCOLOMBIANA DE SEGURIDAD S.A. INFORMACIÓN LTDA.
GREENSQA S.A. POWER TEAM LTDA.
GRUPO CUBO LTDA. PROASISTEMAS LTDA.
GRUPO SYNERTIC U-MYND LTDA. PROCÁLCULO PROSIS S.A.
HONOR SERVICIOS DE SEGURIDAD PSL PRODUCTORA DE SOFTWARE S.A.
LTDA. QUASAR SOFTWARE LTDA.
IBM DE COLOMBIA S.A. QUBIT INTERNACIONAL
ICONO MULTIMEDIA S.A. QUIMICOS DEL CAUCA LTDA.
INDUSTRIA COLOMBIANA DE REGISTRADURIA NACIONAL DEL
ELECTRÓNICOS Y ELECTRODOMÉSTICOS ESTADO CIVIL
S.A. REDCAMPO LTDA.
INDUSTRIAS ALIADAS S.A. SÁENZ AUDITORES CONSULTORES S.A.
INGENIO COLOMBIANO INGCO LTDA. SENA
INGERSCHOFT LTDA SERVIMETERS S.A.
INGESET TELECOMUNICACIONES SISTEMAS INTEGRALES DE
INNERSOFT LTDA. INFORMÁTICA S.A.
INTEGRAR S.A. SISTEMAS Y TECNOLOGÍA PARA EL
INTERGRUPO S.A. SECTOR ODONTOLÓGICO
INTERTEK (ODONTOTECNÍA LTDA)
INSTITUCION UNIVERSITARIA ANTONIO SOFTMANAGEMENT S.A.
JOSÉ CAMACHO SOFTWARE QUALITY ASSURANCE S.A.
KAOME SCRIPTA SOFTWARE LTDA.
KEYWORD E-FACTORY LTDA. SENA
LABORATORIOS DE SOFTWARE S.A. SENCO COLOMBIA
LATINOAMERICANA DE SOFTWARE S.A. SERVIMETERS S.A.
LINALCA S.A. SERVISOFT S.A.
M & G SISTEMAS LTDA. SITEL
MAREIGUA LTDA. STRATEGIKA
MEGABANCO UIS -UNIVERSIDAD INDUSTRIAL DE
MINISTERIO DE TECNOLOGÍAS DE LA SANTANDER
INFORMACIÓN Y LAS UNISYS DE COLOMBIA S.A.
COMUNICACIONES UNIVERSIDAD DE LOS ANDES
MV-TEL CONSULTORES LTDA. UNIVERSIDAD AUTÓNOMA DE
NETLOGISITK OCCIDENTE
NEWNET S.A. UNIVERSIDAD DE CUNDINAMARCA
PARTNERS SYSTEM TECHNOLOGICAL UNIVERSIDAD FRANCISCO DE PAULA
OUTSOURCING SANTANDER
PLANETA4D SAS UNIVERSIDAD DEL CAUCA
POWER TEAM LTDA. UNIVERSIDAD DEL VALLE
PROMOTORA HOTEL DANN CARLTON UNIVERSIDAD NACIONAL DE COLOMBIA
BARRANQUILLA S.A. UNIVERSIDAD COOPERATIVA DE
NCR COLOMBIA LTDA. COLOMBIA
NETWORK COMPUTER SYSTEM E.U. UNIVERSIDAD DEL VALLE
NEWSOFT LTDA. UNIVERSIDAD TECNOLÓGICA DEL
NEXOS SOFTWARE CHOCÓ
NON PLUS ULTRA S.A. UNYDOS CONSULTING S.A.
OPEN SYSTEMS LTDA. VC@SOFT LTDA
PARQUE TECNOLÓGICO DE LA VIANET WS PARQUESOFT
UNIVERSIDAD SAN BUENAVENTURA – WORLDCAD LTDA.
PARQUESOFT
ICONTEC cuenta con un Centro de Información que pone a disposición de los interesados
normas internacionales, regionales y nacionales.
DIRECCIÓN DE NORMALIZACIÓN
GUÍA TÉCNICA COLOMBIANA GTC 199
CONTENIDO
Página
INTRODUCCIÓN
1. OBJETO Y CAMPO DE APLICACIÓN ........................................................................1
2. REFERENCIAS NORMATIVAS ...................................................................................1
3. TÉRMINOS Y DEFINICIONES .....................................................................................2
4. LA FUNCIÓN GERENCIAL..........................................................................................2
4.1 INFORMACIÓN GENERAL..........................................................................................2
4.2 EVIDENCIA DEL COMPROMISO Y EL SOPORTE DE LA GERENCIA.....................2
5. FUNCIONES DE LA DOCUMENTACIÓN DEL SOFTWARE ......................................3
5.2 COMUNICACIÓN CON LA GERENCIA ......................................................................3
5.3 COMUNICACIÓN ENTRE LAS TAREAS ....................................................................3
5.4 ASEGURAMIENTO DE LA CALIDAD .........................................................................3
5.5 INSTRUCCIÓN Y REFERENCIA .................................................................................3
5.6 SOPORTE PARA EL SOFTWARE ..............................................................................3
5.7 REFERENCIA HISTÓRICA..........................................................................................3
6. ESTABLECIMIENTO DE LAS POLÍTICAS DE DOCUMENTACIÓN ..........................4
7. ESTABLECIMIENTO DE NORMAS Y DIRECTRICES PARA

LA DOCUMENTACIÓN................................................................................................5
Pág.
7.2 SELECCIÓN DE UN MODELO DE CICLO DE VIDA DEL SOFTWARE.....................5
7.3 DEFINICIÓN DEL TIPO Y DEL CONTENIDO DEL DOCUMENTO.............................6
7.4 DEFINICIÓN DE LA CALIDAD DE LOS DOCUMENTOS ...........................................8
7.5 DEFINICIÓN DE LOS FORMATOS DE LOS DOCUMENTOS ....................................8
7.6 DEFINICIÓN DE UN SISTEMA DE IDENTIFICACIÓN DE DOCUMENTOS ...............9
8. ESTABLECIMIENTO DE LOS PROCEDIMIENTOS PARA

LA DOCUMENTACIÓN................................................................................................9
9. ASIGNACIÓN DE RECURSOS PARA LA DOCUMENTACIÓN ...............................10
9.1 PERSONAS................................................................................................................10
9.2 INSTALACIONES.......................................................................................................11
9.3 FINANCIACIÓN..........................................................................................................11
10. PLAN PARA LA DOCUMENTACIÓN........................................................................11
10.1 INFORMACIÓN GENERAL........................................................................................11
10.2 INFORMACIÓN EN EL PLAN PARA LA DOCUMENTACIÓN .................................11
10.3 CRONOGRAMA PARA LA DOCUMENTACIÓN.......................................................12
BIBLIOGRAFÍA......................................................................................................................15
DOCUMENTO DE REFERENCIA..........................................................................................16
ANEXO A (Informativo)
LISTA DE VERIFICACIÓN PARA LA GESTIÓN DE LA
DOCUMENTACIÓN DEL SOFTWARE..................................................................................13
INTRODUCCIÓN
La documentación es necesaria para todas las fases del ciclo de vida del software. Como
resultado, la preparación y el mantenimiento de la documentación constituyen un esfuerzo
necesario y continuo, desde la introducción del software hasta su disposición final. La
documentación empieza y es consistente con un proceso de ciclo de vida del software, como la
iniciación de un proyecto de software y continúa con el diseño, desarrollo, , instalación, uso,
modificación y mejora del software. El proceso de documentación se puede considerar
terminado únicamente cuando la información sobre el software ya no es necesaria y se da por
terminado el uso del software.
La documentación es un componente esencial para el éxito de cualquier proyecto de software,

y la producción de la documentación implica el compromiso de tiempo, esfuerzo y dinero. Es
responsabilidad de la gerencia garantizar el despliegue eficaz de tales recursos que reconocen
la importancia de la documentación para la calidad y el éxito del producto de software.
GTC 182 es una de las directrices del proceso de documentación de la NTC 4243 (desde el
punto de vista de la gestión de los productos del proceso de documentación). ISO/IEC
15910:1999 e ISO/IEC FDIS 19019, son directrices para el proceso de documentación del usuario.
Estos documentos son útiles en la integración del proceso de documentación y desarrollo del
software. ISO/IEC 6592:2000 es útil para la identificación del contenido de los documentos.
Las directrices para el proceso de documentación de NTC 4243 y esta guía técnica describen
un punto de vista de gestión de la documentación del software. Las relaciones entre este
documento y otras normas internacionales relacionadas se ilustran en la Figura 1. Esta guía es
una de las directrices para el proceso de documentación de NTC 4243. La Sección 6 incluye
una referencia al proceso de documentación del usuario de ISO/IEC 15910:1999 e ISOIEC
FDIS 18019; y 7.2 hace referencia a ISO/IEC CD 15289 ilustrando documentos típicos de
desarrollo y producto.
Directrices para el proceso Información en la cubierta

Gestión de de documentación de la documentación
la documentación del usuario para empaque
ISO / IEC ISO / IEC

GTC 182
18019 9127
Overall
ISO / IEC
15910
Contractual
ISO / IEC ISO / IEC

NTC 4243
15289 6592
Particularización Descripción de los Jerarquía de

del proceso elementos de información la documentación
de documentación del ciclo de vida
Figura 1. Relación entre la GTC 182 y las normas internacionales de documentación

TECNOLOGÍA DE LA INFORMACIÓN.
DIRECTRICES PARA LA GESTIÓN DE LA DOCUMENTACIÓN DEL SOFTWARE
1. OBJETO Y CAMPO DE APLICACIÓN
Esta guía técnica ofrece una guía sobre la gestión de la documentación del software para los
gerentes responsables de la producción de software o productos basados en software. Esta
guía está destinada a ayudar a los gerentes a garantizar que se produce una documentación
eficaz en su organización.
Esta guía técnica trata de las políticas, normas, procedimientos, recursos y planes con los
cuales los gerentes deben estar involucrados con el fin de hacer la gestión eficaz de la
documentación del software.
La guía que se suministra esta destinada para aplicación a todos los tipos de software, desde
el programa más sencillo hasta el conjunto o sistema de software más complejo. Se cubren
todo los tipos de documentación con relación a todas las fases del ciclo de vida del software.
Los principios para la gestión de la documentación del software son los mismos
independientemente del tamaño de un proyecto. Para proyectos pequeños, la mayoría de los
detalles que se indican en esta guía pueden no ser aplicables, pero los principios siguen siendo
los mismos. Los gerentes pueden adaptar las recomendaciones a sus necesidades
particulares.
La guía que se suministra aquí se da desde el punto de vista de la gestión de la documentación

del software. No se suministra asesoría detallada sobre, por ejemplo, el contenido ni la
organización de los documentos del software.
2. REFERENCIAS NORMATIVAS
Los siguientes documentos de referencia son indispensables para la aplicación de esta guía.
Para referencias con fecha, únicamente se aplica la edición citada. Para referencias sin fecha,
se aplica la última edición del documento citado (incluyendo todas las enmiendas).
NTC 4243, Tecnología de la información. Proceso del ciclo de vida del Software.
ISO/IEC 18019:2004, Software and System Engineering. Guidelines for the Design and
Preparation of User Documentation for Application Software.
1 de 16
3. TÉRMINOS Y DEFINICIONES
Para los propósitos de esta guía técnica, se aplican los siguientes términos y definiciones.
3.1 Documento. Unidad de información identificada singularmente para uso humano, por
ejemplo un informe, una especificación, un manual o un libro, en forma impresa o electrónica.
3.2 Documentación. Colección de documentos relacionados que se diseñan, redactan,

producen y mantienen.
3.3 Producto de software. Conjunto de programas de computador, procedimientos, y

posiblemente los datos y la documentación asociados.
[NTC 4243].
4. LA FUNCIÓN GERENCIAL
4.1 INFORMACIÓN GENERAL
Los gerentes comprometen sus organizaciones en un esfuerzo de documentación y sustentan

tal esfuerzo mediante la implementación de políticas, normas, procedimientos, asignación de
recursos y planes para la documentación. Se puede considerar que el desempeño eficaz de la
gestión de la documentación del software se basa en dos elementos como se indica a
continuación:
a) Compromiso de la gerencia con la documentación: reconocimiento de que la

documentación del software es importante y se debe planificar, diseñar, desarrollar,
probar, revisar, aprobar, distribuir y mantener.
b) Soporte de la gerencia:
1) guía e incentivos para que el personal produzca la documentación requerida,
2) suministro de recursos para facilitar la labor,
3) evidencia del compromiso y el soporte de la gerencia.
4.2 EVIDENCIA DEL COMPROMISO Y EL SOPORTE DE LA GERENCIA
El compromiso de la gerencia con la documentación debería incluir el suministro y

mantenimiento de varios elementos:
a) declaraciones sobre la política de la documentación,
b) normas y directrices que se hayan identificado para todos los aspectos de la

documentación del software,
c) procedimientos publicados sobre documentación,
d) asignación de los recursos adecuados para la documentación,
e) inclusión de la planificación de la documentación como parte integral del ciclo de vida de

software,
2
f) revisión continua para garantizar el cumplimiento y la mejora de las políticas, las

normas, los procedimientos y los planes de documentación.
5. FUNCIONES DE LA DOCUMENTACIÓN DEL SOFTWARE
Para hacer la gestión eficaz de la documentación del software, los gerentes deberían conocer
las diferentes funciones realizadas por ella, incluyendo la documentación de usuario, desarrollo
y gestión.
Se puede considerar que la documentación del software tiene seis funciones principales que se
describen en las siguientes secciones: comunicación con la gerencia, comunicación entre los
grupos de trabajo de desarrollo, aseguramiento de la calidad, instrucción y referencia para
usuarios, comunicación para el mantenimiento del software y referencia para otros proyectos.
5.2 COMUNICACIÓN CON LA GERENCIA
Durante el desarrollo del software, es necesario que la gerencia esté informada sobre el
progreso, los problemas y las expectativas. Los informes periódicos, el seguimiento del
progreso frente a los cronogramas y planes de organización para el próximo periodo
suministran mecanismos de control y visibilidad para un proyecto. La comunicación con la
gerencia da sustento a la dirección y las decisiones sobre la continuación del proyecto y la
asignación de recursos.
5.3 COMUNICACIÓN ENTRE LAS TAREAS
Puede ser necesario que las metodologías para el desarrollo del software establezcan
documentos formales para la comunicación entre las diversas tareas. Muchos proyectos para el
desarrollo de software se dividen en tareas. Con frecuencia éstas son realizadas por grupos
diferentes, tales como especialistas, analistas, diseñadores, programadores, que necesitan un
medio de comunicación entre sí. Por ejemplo, puede ser necesario que los analistas presenten
requisitos formales a los diseñadores y que a su vez los diseñadores suministren
especificaciones formales de diseño a los programadores.
5.4 ASEGURAMIENTO DE LA CALIDAD
Aquellos que tienen la responsabilidad del aseguramiento de la calidad del software pueden
necesitar establecer documentos formales para los procesos, tanto del producto de software
como del aseguramiento de la calidad del software, que se requieren para llevar a cabo y
documentar sus responsabilidades y para satisfacer la calidad exigida de la documentación
para el producto de software.
La documentación se necesita para permitir que aquellos que realizan actividades de

aseguramiento de la calidad realicen sus tareas.
NOTA Las actividades de aseguramiento de la calidad deberían abordar tanto los procesos del ciclo de vida del
software como sus productos documentados.
5.5 INSTRUCCIÓN Y REFERENCIA
La documentación se necesita para permitir que los operadores, usuarios, compradores,

gerentes y otras partes interesadas entiendan y utilicen el producto de software.
3
5.6 SOPORTE PARA EL SOFTWARE
Los programadores a cargo del mantenimiento utilizan la documentación que contiene

descripciones detalladas del software para localizar y corregir los errores y modificar el software
según se requiera.
Los programadores a cargo del soporte de usuario y los instructores pueden utilizar la
documentación para entrenamiento y soporte al usuario.
5.7 REFERENCIA HISTÓRICA
La documentación se puede utilizar como una referencia histórica para otros proyectos. Esta
documentación también se puede usar en la transferencia y la conversión de software para
nuevos entornos.
6. ESTABLECIMIENTO DE LAS POLÍTICAS DE DOCUMENTACIÓN
Las políticas de documentación elaboradas y apoyadas por la gerencia proporcionan una guía
para todos aquellos que toman las decisiones. Las políticas suministran una dirección amplia y
prescripciones no detalladas sobre lo que se ha de hacer y cómo manejar y preparar la
documentación.
Se deberían redactar políticas formales y bien publicitadas para establecer la disciplina que se
requiere para la documentación eficaz del software. Es recomendable que todos aquellos
afectados por las políticas estén informados acerca de ella y tengan entrenamiento para
preparar eficazmente la documentación.
Las políticas deberían dar soporte a los elementos básicos para la documentación eficaz:
a) La documentación se debería exigir para la totalidad del ciclo de vida del software. La
documentación es necesaria durante las primeras etapas de un proyecto y debería estar
disponible y mantenerse durante todo el ciclo de vida del software. Después de terminar
el desarrollo del software, la documentación puede ser necesaria para su uso,
mantenimiento, mejora, conversión o transferencia del software.
b) Se debería hacer gestión de la documentación. Se necesitan dirección y control para

obtener y mantener la documentación. Los gerentes y los especialistas en
documentación deberían elaborar planes detallados que expliquen los productos,
cronogramas, responsabilidades, recursos, aseguramiento de la calidad y
procedimientos de revisión de la documentación.
c) La documentación debería ser adecuada para cada proyecto y para sus lectores. Los
lectores pueden ser gerentes, analistas, personal de oficina, profesionales sin
experiencia en computadores, programadores de mantenimiento, etc. Dependiendo de
las labores, ellos necesitan de varios grados de detalle y presentaciones diferentes del
material. Un especialista en documentación debería estar a cargo diseñando
correctamente diferentes tipos de documentación destinada a diferentes lectores.
d) El proceso de documentación debería estar planificado e integrado en el proceso global

del ciclo de vida del software. Los procesos del ciclo de vida del software y los requisitos
de documentación deberían estar definidos.
NOTA Véase la NTC 4243 e ISO/IEC 15910 e ISO/IEC 18019 con respecto a una guía más detallada.
4
e) Las normas sobre documentación deberían estar identificadas y se deberían utilizar. Es

recomendable que las normas existentes se adopten siempre que sea posible. Cuando
no existen normas adecuadas, se recomienda desarrollar directrices y normas, según se
requieran.
f) Se deberían especificar y utilizar herramientas de soporte. Se recomienda la utilización

de herramientas para facilitar el desarrollo, mantenimiento y distribución de los
productos de software, incluyendo la documentación, siempre que sea económicamente
factible.
7. ESTABLECIMIENTO DE NORMAS Y DIRECTRICES PARA LA DOCUMENTACIÓN
Siempre que sea conveniente se recomienda adoptar las directrices existentes. Sin embargo, si
no existen directrices o no son adecuadas, la organización debería obtener estas directrices a
partir de normas nacionales o internacionales.
Estas normas y directrices facilitan establecer la manera en que se ejecutan las tareas de la
documentación y proporcionan criterios tanto para planificar los recursos de la documentación
como para juzgar la completitud, utilidad e idoneidad de la documentación del software de la
organización.
Cuando se subcontrata el desarrollo del software, el contrato del software debería especificar la
norma que debe cumplir la documentación para cualquier ciclo de vida del software. Debería
especificar un plan para la gestión del desarrollo de la documentación, el tipo de documentos
que se van a suministrar, el nivel de calidad para cada uno de los documentos y la revisión de
la documentación, pruebas y aprobación de procedimientos.
Se recomienda a las organizaciones desarrollar directrices que brinden asesoría con respecto
al uso de las normas y las directrices en el ámbito general. La opinión gerencial y los requisitos
contractuales con frecuencia llevarán a la adaptación de la guía general a cada proyecto. La
aplicación de las normas de documentación permitirá a los gerentes del proyecto determinar:
a) Qué tipos de documentos se requieren.
b) Cuánta documentación se va a suministrar.
c) Qué deben contener los documentos.
d) Qué nivel de calidad se debe lograr.
e) Cuándo se deben producir los documentos.
f) Cómo se debe almacenar, mantener y comunicar la documentación.
Los numerales 7.2 a 7.6 presentan los tipos de directrices que se deben considerar y
suministran para cada uno, una visión general de sus aplicaciones.
7.2 SELECCIÓN DE UN MODELO DE CICLO DE VIDA DEL SOFTWARE
Existe una variedad de modelos del ciclo de vida del software, con diferente terminología para
las diferentes fases, por ejemplo, ISO/IEC TR 15271 - guía para NTC 4243, para directrices
5
sobre modelos de ciclo de vida con base en los procesos y la terminología de NTC 4243.
Desde el punto de vista de la documentación del software, el modelo de ciclo de vida del
software seleccionado debería dar soporte a la definición, la planificación y programación de
las actividades del ciclo de vida y su documentación asociada para cualquier proyecto
particular de software. Los gerentes del proyecto deberían, por lo tanto, seleccionar un modelo
de ciclo de vida del software adecuado para un proyecto y garantizar que éste se aplique en el
proyecto.
Los procesos definidos, las fases y las tareas asociadas ayudarán a monitorear el progreso de
todo proyecto de software. La producción de la documentación asociada a una fase particular
puede, por ejemplo, utilizarse como un punto de verificación para la revisión, aprobación y
finalización de esa fase antes de empezar la siguiente.
7.3 DEFINICIÓN DEL TIPO Y DEL CONTENIDO DEL DOCUMENTO
7.3.1 Introducción
Los siguientes numerales no son ni exhaustivos ni definitivos y pueden servir como una lista de
verificación para la gestión de los principales tipos de documentación de software que los
gerentes deberían suministrar al definir los tipos de documentos del ciclo de vida de su sistema.
7.3.2 Documentación de desarrollo
Se recomienda la creación de documentación que proporcione una visión general durante las
actividades de desarrollo del software, que comúnmente incluye los requisitos del software, su
diseño, las pruebas y el aseguramiento de la calidad. La documentación de desarrollo incluye
descripciones técnicas detalladas del software, incluyendo programa, módulo o lógica del
objeto y sus interrelaciones, formatos de datos y almacenamiento. Los documentos de
desarrollo sirven para los siguientes fines:
a) Registrar la historia del desarrollo del software.
b) Permitir a los gerentes evaluar el progreso del desarrollo, rastrear y controlar el proyecto
de software.
c) Identificar las responsabilidades del equipo a cargo del desarrollo, registrando las
funciones y responsabilidades con respecto al software, el tema en cuestión, la
documentación, el aseguramiento de la calidad y cualquier otra.
d) Formar la base de la documentación de soporte del software que requieren los

programadores de mantenimiento como parte de la documentación del producto.
e) Servir como vehículo de comunicación entre aquellos involucrados en el proceso del

ciclo de vida de desarrollo, registrando los detalles de las decisiones que se toman
sobre los requisitos del software, su diseño, codificación, pruebas, mantenimiento,
soporte y operaciones.
Los documentos comunes de desarrollo incluyen los siguientes:
- Solicitud para la iniciación del proyecto, incluyendo la formulación del concepto y la

determinación de la necesidad.
- Estudios de factibilidad.
6
- Especificaciones funcionales y de desempeño.
- Especificaciones de diseño que incluyan especificaciones para los datos y el programa.
- Planes de desarrollo.
- Integración de software y planes de prueba.
- Planes, normas y cronogramas de aseguramiento de la calidad.
- Información sobre pruebas y seguridad.
7.3.3 Documentación del producto
La documentación del producto suministra la información necesaria para el uso,

mantenimiento, mejora, conversión y transferencia de un producto de software. La
documentación del producto sirve para los siguientes propósitos:
a) Suministrar información de referencia y capacitación para cualquier persona que utilice,

demuestre y opere un producto de software.
b) Describir el producto de software para permitir a los diseñadores y programadores,

diferentes de aquellos que desarrollaron el software, mantener y mejorar el software.
c) Promover el mercadeo y la adquisición de productos de software.
La documentación del producto se debería dirigir a lectores tales como:
- Usuarios que ingresan datos, recuperan información y resuelven problemas con el

software.
- Operadores que ejecutan el software en un sistema de computadores.
- Programadores de mantenimiento que mejoran, mantienen o cambian el software.
- Compradores de paquetes de software para la selección, instalación, operación y

obtención de asistencia en el uso de las funciones.
Los documentos comunes del producto incluyen:
- Material promocional que anuncia la disponibilidad de un producto de software y detalla

sus funciones, entorno operativo, etc.
- Folletos del producto y boletines informativos.
- Manuales de instrucción.
- Manuales de referencia y guías de usuario.
- Manuales de soporte del software.
- Guías y materiales para los gerentes que supervisan el uso del software.
7
- Información general que describe un producto de software para cualquiera interesado

en él.
7.3.4 Documentación de la gestión del proyecto
La documentación de la gestión del proyecto suministra la información relacionada con la

duración de un producto desde el punto de vista de la gestión. Se debería crear documentación
para gestionar los proyectos de software, incluyendo:
a) Cronogramas para cada fase de los procesos de desarrollo, mantenimiento y

operaciones y registro de los cambios en el cronograma.
b) Registros del software acordado o de los cambios en la documentación.
c) Registros de las decisiones relacionadas con el desarrollo, el mantenimiento o las

operaciones.
d) Definiciones de las responsabilidades.
e) Registros de las revisiones y las aprobaciones.
7.4 DEFINICIÓN DE LA CALIDAD DE LOS DOCUMENTOS
Los gerentes deberían determinar la manera en que se va a obtener y mantener la calidad,

consistente con los requisitos de la gestión del proyecto y la calidad. Los gerentes deberían
establecer normas para el nivel de calidad adecuado para los diferentes tipos de
documentación, operaciones y funciones descritos, así como para los tipos de proyectos.
Las consideraciones sobre la calidad del documento se aplican al contenido, la estructura y la

presentación de la documentación:
a) La calidad del contenido se puede medir en términos de precisión, completitud

relevancia y claridad.
b) La calidad de la estructura se puede medir mediante la facilidad con que un lector

puede ubicar la información mediante el uso de estilos diferentes, organización lógica,
índices y uso de diagramas, tablas e ilustraciones.
c) La calidad de la presentación debería ser adecuada para el tipo de lectores. Por

ejemplo, una guía de usuario podría tomar la forma de un conjunto de páginas impresas
engrapadas o una versión electrónica, podría tener ilustraciones amplias diseñadas por
un experto gráfico o podría estar presentada en un formato visual en un dispositivo
electrónico de usuario.
NOTA Con respecto a las directrices sobre el proceso de documentación véase la ISO/IEC 15910:1999.
7.5 DEFINICIÓN DE LOS FORMATOS DE LOS DOCUMENTOS
Los formatos normalizados para los documentos facilitan:
a) El mantenimiento del control de la calidad de los documentos.
b) La preparación de los documentos.
c) El aseguramiento de la facilidad de lectura de los documentos.

8
d) El mantenimiento y la reutilización de la información entre los documentos.
La información se puede presentar en una variedad de formatos. Las especificaciones de

diseño, por ejemplo, se pueden mostrar en formas predefinidas. La capacitación de los
usuarios se puede lograr por medio de programas de entrenamiento en línea, en salones de
clase o a través de talleres y material de instrucción.
El formato del documento puede variar de un proyecto a otro. Los formatos normalizados para
los documentos se deberían adaptar aplicando factores tales como tamaño del proyecto,
audiencias y contenido que se va a tratar, número de fases identificadas y grado hasta el cual
la documentación es accesible en línea de manera interactiva, y el presupuesto de la
documentación.
Al diseñar los formatos, se debería pensar en si los documentos se van a trasladar para
distribución internacional y para traducción. Los términos coloquiales nacionales y los sesgos
culturales se deberían evitar.
Las normas y las directrices de una organización para los formatos de los documentos se
deberían definir de manera tal que permitan la flexibilidad en la selección de los formatos
adecuados para un proyecto.
NOTA ISO/IEC FDIS 18019 suministra guías sobre los formatos para la documentación de usuario.
7.6 DEFINICIÓN DE UN SISTEMA DE IDENTIFICACIÓN DE DOCUMENTOS
Un medio estándar para la identificación de los documentos es esencial para el control eficaz
de la documentación. La información de identificación puede incluir:
a) Título del documento.
b) Esquema de numeración de la referencia del documento.
c) Esquema de numeración de la versión del documento.
d) Fecha de publicación y revisiones.
e) Nombre(s) del autor(es) e identificación de la organización.
f) Autoridad para revisión y aprobación.
g) Protección e identificación de derechos de copia.
h) Identificación de la organización que lo publica.
Cuando los documentos se publican en forma de hojas sueltas, cada página debería estar
identificada de manera única, por ejemplo con el número de referencia del documento, número
de página, fecha, y número de publicación y revisión.
8. ESTABLECIMIENTO DE LOS PROCEDIMIENTOS PARA LA DOCUMENTACIÓN
Los procedimientos deberían implementar las políticas de la documentación y definir las

secuencias de la documentación consistente con el proceso del ciclo de vida del software y la
gestión de la documentación del software de la siguiente manera:
9
a) Establecimiento de objetivos.
b) Planificación.
c) Análisis y diseño.
d) Desarrollo y revisión.
e) Producción.
f) Evaluación y actualización, con procesos subyacentes de control, almacenamiento,

mantenimiento de copias de respaldo, distribución, disposición y archivo.
Los procedimientos también deberían identificar la gestión de la configuración del documento y

los puntos de verificación, medidas y métodos del aseguramiento de la calidad.
NOTA ISO/IEC 18019 suministra guías sobre las actividades en el ciclo de vida de la documentación de usuario.
9. ASIGNACIÓN DE RECURSOS PARA LA DOCUMENTACIÓN
9.1 PERSONAS
9.1.1 Gerentes
Los gerentes deberían garantizar que se asignan las responsabilidades de la documentación a

las personas calificadas. El proceso de desarrollo y documentación del software tiene funciones
para personas con conocimiento de:
a) Software, para desarrollar el Software.
b) El tema en cuestión, incluyendo las características del público o del cliente, para
suministrar información acerca de la aplicación a la cual se dirige el software.
c) Documentación, para desarrollar la documentación del producto.
9.1.2 Miembros del equipo del proyecto
Es recomendable que los miembros del equipo del proyecto tengan experiencia en técnicas y
habilidades relacionadas con la documentación (en el nivel necesario). Todos los miembros
deberían estar informados acerca de sus funciones en la documentación y entender la forma
de cumplir sus funciones correspondientes.
a) Los diseñadores y programadores de software deberían tener las habilidades exigidas

para producir la documentación de prueba y desarrollo que describa el producto y sus
funciones.
b) Los especialistas en la materia, deberían tener las habilidades exigidas para suministrar
información para estudios de factibilidad, especificaciones de requisitos, planes de
prueba y aseguramiento de la calidad, planes para la integración del software en su
entorno operativo y tomar parte en su producción, y también para suministrar los
controles y la protección adecuados para el contenido de documentos sensibles.
c) Los especialistas en documentación deberían tener las habilidades exigidas para

diseñar y producir documentación sobre desarrollo del producto, pruebas, capacitación
10
de usuarios, referencia, información de producto, y documentación promocional que se

pueda necesitar como soporte del proyecto.
9.2 INSTALACIONES
Los gerentes deberían garantizar la disposición de instalaciones adecuadas e idóneas para las
actividades y las tareas del proceso de documentación.
Es recomendable disponer de herramientas de software para preparar y controlar la

documentación. Los redactores de la documentación deberían estar familiarizados con estas
herramientas y éstas se pueden usar eficazmente para mejorar la eficiencia de las actividades
y las tareas del proceso de documentación.
9.3 FINANCIACIÓN
Los gerentes deberían suministrar financiación suficiente para las actividades de

documentación. Los recursos para la documentación y los costos asociados se pueden
identificar como elementos de líneas independientes del presupuesto durante todo el ciclo de
vida de desarrollo, dado que pueden formar una parte significativa del costo del desarrollo del
software.
NOTA El costo de la documentación se puede compensar mediante la reducción en los costos para el soporte de
usuario y el mantenimiento del Software.
10. PLAN PARA LA DOCUMENTACIÓN
Un plan para la documentación establece:
- Qué se va a hacer.
- Dónde se va a hacer.
- Cuándo se va a hacer.
- Cómo se va a hacer.
- Quién lo va a hacer.
Un plan para la documentación puede formar parte de un plan global del proyecto o ser un
documento independiente. Para proyectos informales y pequeños un plan puede ser breve.
Para proyectos más grandes se puede requerir de un plan de documentación exhaustivo que
cumpla con las normas establecidas y de un procedimiento de revisión y aprobación formales.
El plan para la documentación se debería distribuir a todos los miembros del equipo del
proyecto y a toda persona que se ocupe de él. También se debería involucrar a los usuarios del
software que se desarrolla para prueba, entrenamiento y operaciones.
10.2 INFORMACIÓN EN EL PLAN PARA LA DOCUMENTACIÓN
El plan para la documentación debería incluir declaraciones sobre:
a) Estructura general de la documentación.

11
b) Tipos y contenido de los documentos.
c) Calidad y formatos de los documentos.
d) Identificación de los documentos.
e) Recolección y almacenamiento de los documentos.
f) Distribución de los documentos.
g) Cronograma para la documentación.
10.3 CRONOGRAMA PARA LA DOCUMENTACIÓN
El cronograma para la documentación debería asignar tiempo para:
a) Planificar los documentos, tomando en consideración las copias electrónicas e

impresas.
b) Revisar el plan para la documentación y los principios generales de la documentación.
c) Preparar los borradores y revisarlos para determinar su precisión técnica, completitud,

exhaustividad, consistencia e idoneidad.
d) Editar los borradores para cumplir con las normas y prácticas sobre documentación,
además de incorporar los comentarios que se originen en las revisiones y las pruebas.
e) Obtener las aprobaciones.
f) Traducir, por ejemplo de japonés a francés, y convertir el borrador en el producto final.
g) Producir documentos finales para distribución, incluyendo la reproducción en formato

electrónico o impreso.
h) Distribuir los documentos.
La planificación debería empezar en etapas tempranas y ser consistente con el modelo del
ciclo de vida del software utilizado. Los gerentes deberían revisar los planes para la
documentación durante todo el ciclo de vida del proyecto. Como todo plan, un plan para la
documentación indica las actividades futuras y está sujeto a cambio. En un proyecto conviene
incorporar revisiones regulares que den como resultado cambios adecuados en el plan para la
documentación.
12
ANEXO A
(Informativo)
LISTA DE VERIFICACIÓN PARA LA GESTIÓN DE LA DOCUMENTACIÓN DEL SOFTWARE
A.1 LISTA DE VERIFICACIÓN DE LAS POLÍTICAS
Se han tomado decisiones para:
a) ¿Producir documentación del software que sea consistente con el modelo del ciclo de
vida del software?
b) ¿Aplicar normas y directrices sobre documentación, incluyendo consideraciones para la

protección de la propiedad intelectual, aplicando disposiciones para las patentes y la
protección?
c) ¿Establecer procedimientos para el desarrollo y el control de la documentación?
d) ¿Disponer de los recursos para la documentación?
e) ¿Utilizar herramientas automatizadas para la documentación?
f) Nombrar o asignar al personal con las habilidades exigidas para que sea responsable
de:
1) ¿Establecer y aplicar las normas y los procedimientos sobre documentación?
2) ¿Controlar la calidad de la documentación, incluyendo pruebas y entrenamiento

de usuarios?
g) ¿Se ha creado y distribuido una política de documentación y un manual de guía para la

documentación al equipo del proyecto?
A.2 LISTA DE VERIFICACIÓN DE LAS NORMAS
Se han adoptado o definido normas para:
a) ¿La documentación del modelo del ciclo de vida del software?
b) ¿Los tipos y el contenido de los documentos para las categorías de audiencia aplicables?
c) ¿Los niveles y las características de la calidad de los documentos?
d) ¿El formato de los documentos?
e) ¿La identificación de los documentos?
A.3 LISTA DE VERIFICACIÓN DEL PROCEDIMIENTO
Se han establecido procedimientos para:
a) ¿La planificación de la documentación?
13
b) ¿El control de la documentación?
c) ¿La producción de la documentación?
d) ¿La revisión y aprobación de la documentación?
e) ¿La distribución de la documentación?
f) ¿El almacenamiento de los documentos de copias maestras y de respaldo?
g) ¿Las actualizaciones de la documentación?
h) ¿El archivo y disposición final de la documentación?
A.4 LISTA DE VERIFICACIÓN DE LA PLANIFICACIÓN DEL PROYECTO
a) Se ha producido un plan de la documentación que incluya:
1) ¿Tipos, contenido, calidad y formatos consistentes con el proceso del ciclo de

vida en uso?
2) ¿Cronogramas que coincidan con el ciclo de vida del proyecto?
3) ¿Presupuesto?
b) Se han asignado responsabilidades para:
1) ¿La preparación de los documentos?
2) ¿La revisión y aprobación de los documentos?
3) ¿Traducciones, conversiones, producción y distribución de los documentos?
c) ¿Se han proporcionado al personal las instalaciones y los recursos adecuados para las
tareas de documentación?
14
BIBLIOGRAFÍA
[1] ISO 10241, International Terminology Standards. Preparation and Layout.
[2] ISO 31 (todas sus partes), Quantities and Units.
[3] ISO 1000, SI Units and Recommendations for the Use of their Multiples and of Certain
other Units.
[4] ISO 690:1987, Documentation. Bibliographic References. Content, Form and Structure.
[5] ISO/IEC 6592:2000, Information Technology. Software Engineering. Guidelines for the
Documentation of Computer-Based Application Systems.
[6] ISO/IEC 9126-1:2001, Information Technology. Software Engineering. Product Quality.

Part 1: Quality Model.
[7] ISO/IEC TR 10000-1, Information Technology. Framework and Taxonomy of

International Standardized Profiles. Part 1: General Principles and Documentation
Framework.
[8] ISO/IEC 12207:1995, Information Technology - Software Engineering - Software Life

Cycle Processes.
[9] ISO/IEC 12207:1995/Amd1:2002, Information Technology. Software Engineering.

Software Life Cycle Processes. Amendment.
[10] ISO/IEC CD 15289, Information Technology - Software Engineering - Guide for the
Application of ISO/IEC 12207 to the Documentation Process.
[11] ISO/IEC 15910:1999, Information Technology. Software Engineering. Software User

Documentation Process.
[12] ISO/IEC 18019:2003, Information Technology. Software Engineering. Guidelines for

Design and Preparation of Software User Documentation.
[13] ISO/IEC Directives, Part 3, Rules for the Structure and Drafting of International
Standards, 1997 Reissued: as Part 2, Version 4, 2001.
[14] IEC 27 (todas sus partes), Letter Symbols to be Used in Electrical Technology.
15
DOCUMENTO DE REFERENCIA
INTERNATIONAL ORGANIZATION FOR STANDARDIZATION. Information Technology.

Guidelines for the Management of Software Documentation. Geneva: ISO, 2005, 22 p (ISO/IEC
TR 9294:2005 (E)).
16

Metodologia GTC 199 Documentación de Software

Cargado por

Información del documento

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Metodologia GTC 199 Documentación de Software

Cargado por

Copyright:

Formatos disponibles

GUÍA TÉCNICA GTC

E: INFORMATION TECHNOLOGY. GUIDELINES FOR THE

CORRESPONDENCIA: esta guía es una adopción idéntica

DESCRIPTORES: tecnología de la información;

Editada por el Instituto Colombiano de Normas Técnicas y Certificación (ICONTEC)

Prohibida su reproducción Editada 2009-12-24

El Instituto Colombiano de Normas Técnicas y Certificación, ICONTEC, es el organismo

La representación de todos los sectores involucrados en el proceso de Normalización Técnica

La GTC 199 fue ratificada por el Consejo Directivo del 2009-12-16

GATTACA S.A. PIRÁMIDE ADMINISTRACIÓN DE

Además de las anteriores, en Consulta Pública el Proyecto se puso a consideración de las

AGENDA DE CONECTIVIDAD DESARROLLOS TECNOLÓGICOS S.A.

1. OBJETO Y CAMPO DE APLICACIÓN ........................................................................1

2. REFERENCIAS NORMATIVAS ...................................................................................1

3. TÉRMINOS Y DEFINICIONES .....................................................................................2

4.1 INFORMACIÓN GENERAL..........................................................................................2

4.2 EVIDENCIA DEL COMPROMISO Y EL SOPORTE DE LA GERENCIA.....................2

5. FUNCIONES DE LA DOCUMENTACIÓN DEL SOFTWARE ......................................3

5.1 INFORMACIÓN GENERAL..........................................................................................3

5.2 COMUNICACIÓN CON LA GERENCIA ......................................................................3

5.3 COMUNICACIÓN ENTRE LAS TAREAS ....................................................................3

5.4 ASEGURAMIENTO DE LA CALIDAD .........................................................................3

5.5 INSTRUCCIÓN Y REFERENCIA .................................................................................3

5.6 SOPORTE PARA EL SOFTWARE ..............................................................................3

5.7 REFERENCIA HISTÓRICA..........................................................................................3

6. ESTABLECIMIENTO DE LAS POLÍTICAS DE DOCUMENTACIÓN ..........................4

7. ESTABLECIMIENTO DE NORMAS Y DIRECTRICES PARA

7.1 INFORMACIÓN GENERAL..........................................................................................5

7.2 SELECCIÓN DE UN MODELO DE CICLO DE VIDA DEL SOFTWARE.....................5

7.3 DEFINICIÓN DEL TIPO Y DEL CONTENIDO DEL DOCUMENTO.............................6

7.4 DEFINICIÓN DE LA CALIDAD DE LOS DOCUMENTOS ...........................................8

7.5 DEFINICIÓN DE LOS FORMATOS DE LOS DOCUMENTOS ....................................8

7.6 DEFINICIÓN DE UN SISTEMA DE IDENTIFICACIÓN DE DOCUMENTOS ...............9

8. ESTABLECIMIENTO DE LOS PROCEDIMIENTOS PARA

9. ASIGNACIÓN DE RECURSOS PARA LA DOCUMENTACIÓN ...............................10

10. PLAN PARA LA DOCUMENTACIÓN........................................................................11

10.1 INFORMACIÓN GENERAL........................................................................................11

10.2 INFORMACIÓN EN EL PLAN PARA LA DOCUMENTACIÓN .................................11

10.3 CRONOGRAMA PARA LA DOCUMENTACIÓN.......................................................12

La documentación es un componente esencial para el éxito de cualquier proyecto de software,

Directrices para el proceso Información en la cubierta

ISO / IEC ISO / IEC

ISO / IEC ISO / IEC

Particularización Descripción de los Jerarquía de

Figura 1. Relación entre la GTC 182 y las normas internacionales de documentación

1. OBJETO Y CAMPO DE APLICACIÓN

La guía que se suministra aquí se da desde el punto de vista de la gestión de la documentación

3.2 Documentación. Colección de documentos relacionados que se diseñan, redactan,

3.3 Producto de software. Conjunto de programas de computador, procedimientos, y

4.1 INFORMACIÓN GENERAL

Los gerentes comprometen sus organizaciones en un esfuerzo de documentación y sustentan

a) Compromiso de la gerencia con la documentación: reconocimiento de que la

1) guía e incentivos para que el personal produzca la documentación requerida,

2) suministro de recursos para facilitar la labor,

3) evidencia del compromiso y el soporte de la gerencia.

4.2 EVIDENCIA DEL COMPROMISO Y EL SOPORTE DE LA GERENCIA

El compromiso de la gerencia con la documentación debería incluir el suministro y

a) declaraciones sobre la política de la documentación,

b) normas y directrices que se hayan identificado para todos los aspectos de la

c) procedimientos publicados sobre documentación,

d) asignación de los recursos adecuados para la documentación,

e) inclusión de la planificación de la documentación como parte integral del ciclo de vida de

f) revisión continua para garantizar el cumplimiento y la mejora de las políticas, las