GA4-220501095-AA4-EV01 - Taller sobre validación de documentos

Tecnólogo en análisis y desarrollo de software

Duban Andres Sanchez Ocampo

Sena
● ¿Qué es un artefacto?
Un artefacto se refiere a cualquier documento, diagrama, modelo, código
fuente u otro elemento producido durante el proceso de desarrollo de
software. Estos artefactos pueden incluir especificaciones de requisitos,
diagramas de flujo, diagramas de clases, código fuente, casos de prueba,
manuales de usuario, entre otros.

Los artefactos son importantes porque ayudan a comunicar, documentar y

organizar el trabajo realizado durante el ciclo de vida del desarrollo de
software. Sirven como registros tangibles de las decisiones tomadas, los
requisitos establecidos, el diseño implementado y otros aspectos del
proyecto.

Los artefactos también facilitan la colaboración entre los miembros del

equipo de desarrollo, proporcionando un punto de referencia común para
discutir y revisar el progreso del proyecto. Además, son útiles para el
mantenimiento y la evolución del software a lo largo del tiempo, ya que
proporcionan información sobre el funcionamiento y la estructura del sistema
desarrollado.
● ¿Tipos de artefactos?
Los artefactos en el desarrollo de software pueden clasificarse en varios tipos,
dependiendo de su propósito, contenido y etapa del ciclo de vida del
desarrollo. Aquí tienes algunos tipos comunes de artefactos:

1. Artefactos de requisitos:
- Documentos de especificación de requisitos.
- Casos de uso.
- Historias de usuario.
- Matrices de trazabilidad de requisitos.
2. Artefactos de diseño:
- Diagramas de casos de uso.
- Diagramas de clases.
- Diagramas de secuencia.
- Diagramas de actividad.
- Modelos de datos.
- Especificaciones de arquitectura.

3. Artefactos de implementación:
- Código fuente.
- Diagramas de despliegue.
- Diagramas de componentes.
- Scripts de configuración.
- Manuales de instalación.

4. Artefactos de pruebas:
- Planes de pruebas.
- Casos de prueba.
- Informes de pruebas.
- Matrices de trazabilidad de pruebas.

5. Artefactos de gestión de proyectos:

- Planes de proyecto.
 - Diagramas de Gantt.
- Informes de estado.
- Matrices de riesgos.

6. Artefactos de documentación:
- Manuales de usuario.
- Manuales técnicos.
- Guías de administración del sistema.
- Documentación de APIs.

7. Artefactos de mantenimiento:
- Informes de incidentes.
- Versiones del software.
- Registros de cambios.

● ¿Qué es la evaluación de artefactos?

La evaluación de artefactos en el contexto del desarrollo de software se
refiere al proceso de revisión y análisis de los diferentes elementos
producidos durante el ciclo de vida del desarrollo. El propósito principal de la
evaluación de artefactos es garantizar la calidad, la coherencia y el
cumplimiento de los requisitos del software en desarrollo.

La evaluación de artefactos puede realizarse de diversas maneras,

dependiendo de la metodología de desarrollo utilizada y de los objetivos
específicos del proyecto. Algunas de las técnicas comunes de evaluación de
artefactos incluyen:
1.Revisión por pares: También conocida como revisión entre compañeros, en
esta técnica, los miembros del equipo revisan y comentan los artefactos
producidos por otros miembros del equipo. Esta revisión puede ser formal o
informal y puede realizarse de manera presencial o mediante herramientas
de colaboración en línea.

2. Inspección de código: En el caso del desarrollo de software, la evaluación

de artefactos puede incluir la inspección del código fuente para identificar
errores, mejorar la legibilidad, garantizar el cumplimiento de estándares de
codificación y optimizar el rendimiento.

3. Pruebas de software: Las pruebas de software son una forma de

evaluación de artefactos que implica la ejecución de casos de prueba
diseñados para probar la funcionalidad y el rendimiento del software. Esto
puede incluir pruebas unitarias, pruebas de integración, pruebas de sistema y
pruebas de aceptación del usuario.

4. Análisis estático: Este enfoque implica el análisis de los artefactos de

software (como el código fuente o la documentación) sin ejecutar el
programa. El objetivo es identificar posibles problemas, como errores de
sintaxis, violaciones de estándares de codificación, o problemas de diseño.

5. Validación de requisitos: En esta técnica, los artefactos de requisitos

(como casos de uso o historias de usuario) se evalúan para garantizar que
representen con precisión las necesidades y expectativas del cliente, y que
sean comprensibles y completos.

● ¿Cómo se realizan?
La realización de la evaluación de artefactos en el desarrollo de software
puede variar según el tipo de artefacto que se esté evaluando, el tamaño y la
complejidad del proyecto, así como las preferencias del equipo de desarrollo.
Sin embargo, aquí hay algunos pasos generales que suelen seguirse en el
proceso de evaluación de artefactos:
1.Establecimiento de criterios de evaluación: Antes de comenzar la
evaluación, es importante definir los criterios que se utilizarán para evaluar
los artefactos. Estos criterios pueden incluir aspectos como la calidad, la
coherencia, la completitud, la claridad y el cumplimiento de los requisitos.

2. Selección de revisores: Seleccionar a los revisores adecuados es

fundamental para garantizar una evaluación efectiva. Los revisores pueden
ser miembros del equipo de desarrollo, expertos en el dominio del problema,
usuarios finales o cualquier otra persona con el conocimiento y la experiencia
necesarios para proporcionar una retroalimentación significativa.

3. Preparación de artefactos: Los artefactos a evaluar deben estar

disponibles y accesibles para los revisores. Esto puede implicar la preparación
de documentos, la configuración de herramientas de revisión de código, la
preparación de casos de prueba, entre otros.

4. Revisión y análisis: Los revisores examinan detenidamente los artefactos

utilizando los criterios establecidos previamente. Esto puede incluir la lectura
de documentos, la revisión de código fuente, la ejecución de pruebas de
software y cualquier otra actividad necesaria para evaluar los artefactos de
manera efectiva.

5. Registro de hallazgos: Durante el proceso de evaluación, los revisores

registran cualquier hallazgo relevante, como errores, inconsistencias, mejoras
sugeridas o cumplimiento de requisitos. Es importante documentar estos
hallazgos de manera clara y precisa para que puedan abordarse
adecuadamente en el proceso de desarrollo.
6.Comunicación de resultados: Una vez completada la evaluación, se
comunican los resultados a los miembros pertinentes del equipo de
desarrollo. Esto puede incluir informes formales de evaluación, reuniones de
retroalimentación o cualquier otra forma de comunicación que facilite la
comprensión y la acción sobre los hallazgos.

7. Iteración: La evaluación de artefactos es un proceso iterativo que puede

repetirse a lo largo del ciclo de vida del desarrollo de software. Los resultados
de una evaluación pueden influir en el refinamiento de los artefactos
existentes, la creación de nuevos artefactos o la modificación de procesos de
desarrollo para mejorar la calidad del producto final.

Al seguir estos pasos y adaptar el proceso según las necesidades específicas

del proyecto, el equipo de desarrollo puede realizar una evaluación efectiva
de los artefactos y mejorar continuamente la calidad y el éxito del software
desarrollado.

● ¿Qué instrumentos se utilizan?

En la evaluación de artefactos en el desarrollo de software, se pueden utilizar
una variedad de instrumentos y herramientas para facilitar el proceso y
obtener resultados más efectivos. Algunos de los instrumentos comunes que
se utilizan incluyen:

1. Herramientas de revisión de código: Estas herramientas automatizan el

proceso de revisión del código fuente, ayudando a identificar errores,
cumplimiento de estándares de codificación y mejoras de rendimiento.
Ejemplos incluyen GitLab, GitHub, Bitbucket y herramientas específicas de
revisión de código como Code Review.
2. Herramientas de análisis estático de código: Estas herramientas analizan
el código fuente en busca de posibles problemas, como errores de sintaxis,
violaciones de estándares de codificación y vulnerabilidades de seguridad.
Ejemplos incluyen SonarQube, ESLint, Pylint, y Checkstyle.

3. Herramientas de gestión de pruebas: Estas herramientas ayudan a

gestionar el proceso de prueba de software, incluyendo la creación de casos
de prueba, la ejecución de pruebas automatizadas y la generación de
informes de pruebas. Ejemplos incluyen TestRail, HP ALM (Application
Lifecycle Management), y JIRA.

4. Herramientas de revisión de documentos: Para la revisión de documentos,

se pueden utilizar herramientas que permitan la colaboración en línea, el
seguimiento de cambios y la gestión de comentarios. Ejemplos incluyen
Google Docs, Microsoft Word con seguimiento de cambios, y herramientas de
gestión del ciclo de vida de documentos.

5. Herramientas de diagramación y modelado: Para evaluar artefactos de

diseño, se pueden utilizar herramientas de diagramación y modelado que
permitan crear y revisar diagramas de manera eficiente. Ejemplos incluyen
Microsoft Visio, Lucidchart, y draw.io.

6. Herramientas de gestión de proyectos: Estas herramientas facilitan la

planificación, seguimiento y gestión general del proyecto, lo que puede incluir
la evaluación de artefactos en el contexto del progreso del proyecto.
Ejemplos incluyen JIRA, Trello, Asana y Microsoft Project.

7. Herramientas de seguimiento de errores y problemas: Estas herramientas

permiten registrar y gestionar problemas identificados durante la evaluación
de artefactos, así como el seguimiento de su resolución. Ejemplos incluyen
JIRA, Bugzilla, y Redmine.

● ¿Qué resultados se obtienen?

Los resultados obtenidos de la evaluación de artefactos en el desarrollo de
software pueden variar según el tipo de artefacto evaluado, los objetivos
específicos de la evaluación y el enfoque utilizado. Sin embargo, algunos
resultados comunes que se pueden obtener incluyen:

1. Identificación de errores y problemas: Uno de los resultados más

importantes de la evaluación de artefactos es la identificación de errores,
inconsistencias y problemas en los artefactos evaluados. Estos pueden incluir
errores de código, deficiencias en la documentación, requisitos ambiguos o
incompletos, entre otros.

2. Recomendaciones de mejora: Además de identificar problemas, la

evaluación de artefactos también puede generar recomendaciones para
mejorar la calidad y la eficacia de los artefactos. Esto puede incluir
sugerencias para mejorar la legibilidad del código, clarificar la
documentación, optimizar el diseño de software, entre otros.

3. Validación de requisitos: La evaluación de artefactos puede ayudar a

validar que los artefactos de requisitos, como casos de uso o historias de
usuario, representen con precisión las necesidades y expectativas del cliente.
Esto puede ayudar a garantizar que el software desarrollado cumpla con los
requisitos del usuario final.

4. Información sobre el estado del proyecto: La evaluación de artefactos

proporciona información sobre el estado actual del proyecto de desarrollo de
software. Esto puede incluir la cantidad y gravedad de los problemas
identificados, el progreso realizado en relación con los objetivos del proyecto
y cualquier riesgo o desafío identificado.

5. Base para la toma de decisiones: Los resultados de la evaluación de

artefactos pueden servir como base para la toma de decisiones en el proceso
de desarrollo de software. Por ejemplo, los problemas identificados pueden
requerir acciones correctivas o ajustes en el plan del proyecto, y las
recomendaciones de mejora pueden influir en futuras decisiones de diseño o
implementación.

6. Documentación de la calidad: Los resultados de la evaluación de artefactos

también pueden servir como documentación de la calidad del software
desarrollado. Esto puede ser útil para auditorías, revisión por parte de partes
interesadas externas y para demostrar el cumplimiento de estándares de
calidad.