El desarrollo de software puede ser un proceso emocionante de resolución de problemas, diseño e ingeniería creativos. Pero debajo de las aplicaciones brillantes y las páginas web pulidas se encuentra el andamiaje menos atractivo pero tan importante que hace posibles buenos resultados de software: la documentación.

La documentación garantiza que los equipos y las partes interesadas individuales estén en la misma página con respecto a los objetivos, el alcance, las restricciones y los requisitos funcionales de un producto o aplicación de software.

Desafortunadamente, el proceso de crear y documentar estos requisitos puede ser tedioso, confuso y desordenado.

Requisitos de software Los documentos pueden convertirse rápidamente en documentos largos, difíciles de manejar y con mucho texto, lo que los hace especialmente vulnerables a errores, inconsistencias e interpretaciones erróneas. Debido a esto, escribir y usar estos documentos puede llevar mucho tiempo y conducir a errores de diseño costosos (y evitables).

Entonces, ¿qué se supone que deben hacer los gerentes de producto, los equipos de software y los líderes empresariales?

Aunque no existe una regla única para todos los enfoques de desarrollo de software, hay formas de reducir los errores, ahorrar tiempo e impulsar resultados efectivos.

A continuación, explicamos los objetivos y beneficios de los documentos de requisitos de software y algunas prácticas recomendadas que lo ayudarán a perfeccionar el proceso de principio a fin.

¿Qué son los documentos de requisitos de software?

Un documento de requisitos de software (también llamado especificaciones de requisitos de software) es un documento o conjunto de documentación que describe las características y el comportamiento previsto de una aplicación de software.

En otras palabras, el documento de requisitos de software (SRD) describe la comprensión de la empresa u organización de las necesidades y dependencias del usuario final (normalmente del cliente), así como cualquier restricción en el sistema.

¿Qué se incluye en un SRD?

Mientras que el SRD funciona como un modelo para administrar el alcance de un proyecto, en última instancia solo define los requisitos funcionales y no funcionales de un sistema. El documento no describe soluciones de diseño o tecnología. Esas decisiones son tomadas más tarde por los desarrolladores.

Un SRD bien escrito debería:

• Dividir el problema en partes manejables.
• Sirve de referencia para pruebas y validación.
• Informar de las especificaciones de diseño (es decir, el SRD debe incluir información suficiente sobre los requisitos del software para hacer un diseño eficaz).
• Proporcionar comentarios al cliente (usuario final).

El SRD demuestra al cliente que su organización entiende el problema que desea resolver y cómo abordar esos problemas a través de soluciones de software. Debido a que los clientes a menudo son partes interesadas directas, es especialmente importante redactar la documentación claramente en términos sencillos (evitando la jerga técnica).

De nuevo, la forma en que escriba su SRD dependerá del enfoque y la metodología a los que se suscriba su equipo u organización. Sin embargo, la organización de estándares IEEE recomienda que los SRD típicos cubran los siguientes temas:

• Interfaces
• Capacidades funcionales
• Niveles de rendimiento
• Estructuras/Elementos de datos
• Seguridad
• Fiabilidad
• Seguridad/Privacidad
• Calidad
• Restricciones y limitaciones

Si cada uno de estos temas se aborda y describe claramente en su documentación, tendrá una imagen más completa de la información necesaria para desarrollar su aplicación.

Cómo concretar su documento de requisitos de software

Sea cual sea el enfoque que adopte para la documentación, siga estas prácticas recomendadas para crear un SRD efectivo y eficiente.

Manténgalo organizado

El nombre del juego es organización. Antes de comenzar a documentar, asegúrese de comenzar con una estrategia de organización para todos los documentos, incluido el lugar donde se almacenan los documentos, cómo garantizar la coherencia y cómo los contribuyentes y colaboradores pueden mantener fácilmente los documentos actualizados. Para ser eficaz, un documento de requisitos de software debe estar organizado y ser claro. Muchas organizaciones confían en las plantillas de la casa para mantener la consistencia en todos los proyectos. Las plantillas son una excelente manera de ahorrar tiempo (solo tiene que rellenar las secciones preorganizadas) y mantener la coherencia en el proceso de documentación.

Sin embargo, las plantillas de documentos a menudo refuerzan el problema de los requisitos largos y pesados de texto. Para evitar atascarse en páginas de texto, considere complementar su proceso de documentación con datos visuales.

Asegúrese de que los requisitos estén completos

Para que un requisito sea» completo», debe incluir toda la información necesaria para implementar el requisito. Esto significa que cuando los diseñadores y desarrolladores van a construir la función, no se dejan hacer suposiciones o conjeturas sobre el requisito.

Por ejemplo, digamos que estás desarrollando una página web. Uno de los requisitos descritos es lo que debe suceder en caso de error. Un requisito incompleto podría decir algo como «En caso de error, el sistema debe salir sin problemas.»

En este caso, «smoothly» no está definido y se deja a la interpretación. Esta ambigüedad podría llevar a una mala interpretación de los resultados deseados (y más trabajo para volver y arreglarlo).

Para evitar esto, escriba un requisito completo que defina el aspecto de una función exitosa:

«En caso de error, el sistema debe mostrar una página de error con el siguiente mensaje:

Uh-oh! Parece que algo salió mal. Por favor, inténtelo de nuevo en unos minutos. Si el problema persiste, póngase en contacto con nuestro equipo de soporte en [email protected]. »

Al definir un requisito completo, hay menos ambigüedad y un resultado claro para que el equipo de desarrollo trabaje.

Hacer comprobables los requisitos

Este es un estándar bastante ubicuo, pero con demasiada frecuencia las organizaciones no escriben requisitos que cumplan completamente con esta regla.Los requisitos

deben ser verificables. De lo contrario, no hay una forma objetiva de saber si el requisito se implementó satisfactoriamente.

Para cada requisito que escriba, asegúrese de que esté validado a través de una o más de las siguientes formas:

• Inspección
• Demostración
• Recorrido
• Pruebas

Los requisitos de alto nivel a menudo se someten a inspecciones o pruebas de usuario, por lo que generalmente se basan en especificaciones más generales. Pero los requisitos de nivel inferior que se someten a pruebas de software probablemente necesitarán especificaciones más detalladas.

Aplicar requisitos funcionales neutrales de implementación

Como señalamos anteriormente, un SRD no es un documento de diseño. No define ni debe definir cómo deben aplicarse los requisitos funcionales desde el punto de vista del diseño.

Por lo tanto, todos los requisitos funcionales deben ser neutrales para la implementación. En otras palabras, los requisitos deben indicar qué debe hacer el sistema, pero no cómo debe hacerlo.

Los requisitos neutrales de implementación presentan varias ventajas, entre las que se incluyen:

• Un proceso de diseño más eficiente
• Requisitos modificables que no dependen de un diseño de implementación específico
• Menos conflictos entre requisitos resultantes de detalles de implementación opuestos

Cualquier restricción en la implementación debe reservarse para los requisitos no funcionales del sistema.

Evaluar la documentación con las partes interesadas

Cuando se hayan documentado todos los requisitos de software, pida a todas las partes interesadas pertinentes que evalúen la documentación final antes de que comience el desarrollo.

Las partes interesadas deben incluir diseñadores y desarrolladores, evaluadores que validarán los requisitos, ingenieros, representantes de usuarios finales y el cliente.

Al hacer que todas las partes interesadas revisen y aprueben la documentación antes de comenzar el desarrollo, mejora la satisfacción de los equipos y aumenta la probabilidad de que los requisitos satisfagan sus necesidades.

Ayude a los desarrolladores de software y a sus equipos a mantenerse al día con diagramas de flujo que trazan de manera eficiente y elegante las especificaciones de sus requisitos de software. Busque una solución de diagramación que le pueda ayudar:

• Organice sus requisitos en un diagrama de flujo para mantener sus componentes distintos, sus dependencias claras y las partes interesadas evidentes.
• Use swimlanes para describir visualmente qué equipos son responsables de cada conjunto de requisitos.
• Modifique rápidamente los requisitos u otros datos a medida que evolucionen las necesidades del proyecto.
• Datos de enlace (incluidos documentos adicionales) para apoyar e informar su proyecto en curso.
• Comparta la documentación (y cualquier cambio) de forma instantánea con las partes interesadas relevantes.

la Documentación no tiene que ser una tarea. Con Lucidchart, puede documentar fácilmente procesos, historias de usuarios y requisitos de software en una sola ubicación. Al definir visualmente las especificaciones de sus requisitos, usted y su equipo podrán encontrar y actuar sobre la información rápidamente, al tiempo que reducen las oportunidades de errores, inconsistencias e interpretaciones erróneas.

Comience a documentar

Obtenga visibilidad de sus sistemas técnicos existentes con Lucidchart hoy mismo.

Aprender