Las Bases de la Documentación de Requerimientos para un Sistema

Entrada de blog realizada en conjunto por:
Yahir Alejandro Gutierrez Castro
Erick Ramirez Valenzuela 
Cristian Daniel Romero Hernandez
Jesus Alfredo Mendez Raya
Erik Armando Ramirez Gonzalez

En el mundo actual, la tecnología desempeña un papel fundamental en prácticamente todas las áreas de nuestras vidas. Desde sistemas de atención médica hasta aplicaciones móviles, la tecnología está en todas partes. Para que estas soluciones tecnológicas sean efectivas, es esencial que se definan de manera clara y precisa los requisitos del sistema que guiarán su diseño y desarrollo.

La documentación de requerimientos de sistema es un componente esencial en cualquier proyecto de desarrollo de software. Esta etapa inicial establece las bases para el éxito del proyecto al definir claramente qué debe hacer el sistema y qué se espera de él. En este blog, exploraremos la importancia de la documentación de requerimientos de sistema y proporcionaremos consejos prácticos para llevar a cabo este proceso de manera efectiva.

 

* * * * *  ¿Qué son los Requerimientos de Sistema?  * * * * *

 

Los requerimientos de sistema son una descripción detallada de lo que se espera que el sistema haga. Estos incluyen las funcionalidades, características y restricciones que deben cumplirse para satisfacer las necesidades del usuario. Los requerimientos de sistema actúan como un contrato entre los solicitadores del proyecto y el equipo de desarrollo, garantizando que todas las partes tengan una comprensión común de lo que se va a construir.

 

* * * * * La Importancia de Documentar los Requerimientos de Sistema * * * * *

 

La documentación de requerimientos garantiza que todos los involucrados en el proyecto, desde los desarrolladores hasta los usuarios finales, tengan una comprensión clara y común de lo que se espera del sistema. Esto reduce la ambigüedad y evita malentendidos.

Sirven como una guía para el equipo de desarrollo. Proporcionan una hoja de ruta clara que ayuda a los desarrolladores a planificar y ejecutar las tareas necesarias para construir el sistema.

Cuando se documentan los requerimientos, cualquier cambio en las especificaciones debe registrarse y gestionarse adecuadamente. Esto evita la "deriva de requerimientos" y asegura que el proyecto se mantenga enfocado en sus objetivos originales.

Dichos requerimientos documentados son verificables y pueden utilizarse para validar que el sistema cumple con las expectativas del usuario. Esto facilita las pruebas y la garantía de calidad.

 La documentación de requerimientos facilita la comunicación entre los clientes del sistema, lo que es crucial para el éxito del proyecto. Permite a los clientes y usuarios expresar sus necesidades de manera clara y a los desarrolladores entender y abordar esas necesidades.

 

* * * * * Cómo Documentar Los Requerimientos de un Sistema * * * * *

 

Debemos comenzar por identificar y priorizar los requerimientos que sean esenciales. Es importante distinguir entre requerimientos funcionales (qué debe hacer el sistema) y requerimientos no funcionales (cómo debe hacerlo). Luego, hacer la elección de una metodología de documentación de requerimientos que se adapte a las necesidades de su proyecto. Ejemplos incluyen el enfoque clásico de especificaciones detalladas o métodos ágiles como User Stories.

Ejemplo de un User Story.

Evitar el uso de jerga técnica o ambigüedad. Utilice un lenguaje claro y conciso que sea comprensible para todas las partes involucradas.

A menudo, los diagramas y gráficos pueden ayudar a visualizar los requerimientos. Utilice herramientas como diagramas de flujo, diagramas de casos de uso o wireframes cuando sea apropiado.

 A medida que evoluciona el proyecto, asegúrese de mantener la documentación de requerimientos actualizada para reflejar los cambios y las adiciones.

  * * * * * Elementos Clave de la Documentación de Requerimientos * * * * *

La documentación de requerimientos puede tomar diversas formas, pero algunos elementos clave son fundamentales para su compresión y utilidad:
Requerimientos funcionales y no funcionales.
Los requerimientos funcionales describen las funciones especificas que el sistema o el cliente debe realizar, mientras que los requerimientos no funcionales se refieren a características internas dentro del sistema o que no pueden ser alcanzadas por el cliente o el hardware donde se ubica el sistema.

Los casos de uso describen cómo es que los usuarios interactúan con el sistema. Dichas especificaciones detallan escenarios específicos de uso y son cruciales para comprender las posibles necesidades que presenten los usuarios del sistema.

El uso de los diagramas de flujo nos ayudan a visualizar la lógica del sistema y las relaciones entre los componentes. Los diagramas de flujo son útiles para representar procesos, mientras que los diagramas de clases muestran la estructura de objetos.

Existen varias herramientas disponibles para facilitar la documentación de requerimientos, desde procesadores de texto hasta software de gestión de requerimientos. La elección de la herramienta depende de las necesidades del proyecto y la preferencia del equipo.

* * * * * Desafíos en la Documentación de Requerimientos * * * * *

A pesar de los números beneficios de la documentación de requerimientos, también enfrenta desafíos significativos:

Por ejemplo, los cliente del sistema pueden cambiar de opinión o sugerir nuevas necesidades a lo largo del proyecto, lo que puede dificultar la estabilidad de los requerimientos y requiera replantar la estructura del mismo.
También, la ambigüedad y la falta de detalles en los requerimientos pueden dar lugar a malentendidos y a un desarrollo insatisfactorio.
La documentación de requerimientos debe ser comprensible tanto para los clientes no técnicos como para los integrantes dentro del equipo de desarrollo del sistema. La falta de comunicación genera una gran cantidad de problemas.

Estos son algunos de los tantos problemas que se puede generar a la raíz de la elaboración de un sistema y por consecuente, los requerimientos del sistema.
Dichos problemas pueden ser solucionados rápidamente dependiendo del ingenio y habilidad del desarrollador. Por ejemplo:

La involucración de los clientes desde el principio del proyecto ayuda a comprender mejor sus necesidades y reduce la posibilidad de cambios de último minuto.

* * * * * Herramientas para la Documentación de Requerimientos * * * * *

Existen varias herramientas que pueden facilitar la documentación de requerimientos, como:

Software como Microsoft Visio o Lucidchart, son utiles para la creación de diagramas que visualizan la estructura y la lógica del sistema.

Herramientas como JIRA, Trello o IBM Rational DOORS facilitan la recopilación, gestión y seguimiento de requerimientos.

También, hay herramientas como Confluence o SharePoint que permiten la colaboración en línea para la documentación de requerimientos.

La documentación de requerimientos de sistema es una piedra angular en el proceso de desarrollo de software. Proporciona la base necesaria para un proyecto exitoso al definir claramente qué se espera del sistema y cómo debe comportarse. Al seguir las mejores prácticas y utilizar herramientas adecuadas, los equipos pueden superar estos desafíos y aprovechar al máximo la documentación de requerimientos. En última instancia, esta práctica contribuye de manera significativa al éxito de los proyectos de desarrollo de software, asegurando la entrega de productos que satisfagan las necesidades de los usuarios y los clientes del sistema.

Referencias bibliográficas:
Universidad de Pamplona. (2019). Análisis y Diseño de Sistemas de Información.
Asana. (2023). Cómo redactar un documento de requisitos de software.
Universidad de Granada. Especificación de requerimientos.
Sommerville. (1998). Requerimientos del Software.