Cómo crear un documento de requisitos de software (con ejemplos)

Un documento de requisitos de software puede servir como plan para los desarrolladores que trabajan en un proyecto, proporcionando información detallada sobre el propósito del proyecto, la información del usuario y los requisitos. Puede ayudarte a diseñar y organizar un proyecto de desarrollo de software para tu empresa si aprendes a crear uno.

En este artículo, discutimos lo que es un documento de requisitos de software, explicamos cómo crear uno y proporcionamos ejemplos para que los revise.

12 tipos de ingenieros de software que te ayudarán a encontrar tu lugar en la tecnología

¿Qué es un documento de requisitos de software?

Un documento de requisitos de software es un conjunto de directrices que describe cómo deben construir el software los ingenieros de software. Proporciona información sobre el diseño, el procedimiento y las fases de una iniciativa de desarrollo de software que los programadores pueden consultar a lo largo del proyecto. También describe las preferencias de software del cliente y la empresa. Los desarrolladores muestran al cliente el documento antes de comenzar un trabajo para asegurarse de que están de acuerdo con el esquema y el contenido.

Relacionado: Relacionado: Aprenda a ser un desarrollador de software

¿Por qué son importantes los documentos de requisitos de software para los proyectos?

Hay varias razones por las que los documentos de requisitos de software son importantes para los proyectos:

Proporciona requisitos claros: Disponer de un documento de requisitos de software para un proyecto de software proporciona unos requisitos claros para completar el proyecto, lo que puede reducir la posibilidad de mala comunicación entre los desarrolladores y sus clientes.
Ofrece un plano: Un documento de requisitos de software es un plan para proyectos de software, que puede ayudar a los miembros del equipo a tener una mejor idea de los plazos y requisitos del proyecto.
Evalúa el riesgo: Un documento de requisitos de software evalúa los riesgos y los beneficios de un proyecto, lo que demuestra si merece la pena llevarlo a cabo o no.
Ofrece a los inversores una visión general del proyecto: Un documento de requisitos de software proporciona a los inversores una visión general del proyecto, que puede influir en sus decisiones de inversión.

Relacionado: ¿Qué es el desarrollo de software?

Cómo escribir un documento de requisitos de software

La creación de un documento de requisitos de software implica la redacción de un esquema que sea aprobado por la dirección y el cliente. Estos son los pasos que puedes seguir para crear un documento de requisitos de software:

1. Decide si quieres utilizar una plantilla

Antes de comenzar su documento, decida si desea utilizar una plantilla en línea o si desea crear el esquema por sí mismo. Puedes encontrar plantillas en línea en las que puedes rellenar información sobre el proyecto o puedes utilizar un documento en blanco para crear tu esquema. Si creas el tuyo propio, puedes tener más control sobre la información que quieres incluir y dónde quieres colocarla.

2. Desarrollar la primera parte del esquema

La primera parte del documento de requisitos de software proporciona una introducción y una descripción del proyecto de software. Establece las expectativas para el resto del documento y permite a los miembros del equipo entender por qué el proyecto es importante y a quién puede beneficiar. Esto es lo que puede incluir en la primera parte del esquema:

Introducción: En la introducción, puedes incluir información específica sobre el proyecto, como el nombre del cliente, los nombres de los miembros de tu equipo o el plazo previsto.
Objetivo: Exponga el propósito del proyecto, lo que implica por qué está creando el proyecto y cuáles son los objetivos del mismo.
Audiencia: Define quién puede acceder al documento, incluidos los directores de proyecto, los desarrolladores de software, las partes interesadas y la clientela.
Uso previsto: de los desarrolladores a lo largo de la duración del proyecto, como si deben añadirse a él cuando sea necesario o dejarlo sin modificar.
Alcance: El alcance del proyecto debe incluir información sobre lo que el proyecto logra y dar detalles específicos sobre cómo los usuarios pueden utilizar el software, las características específicas del software y las técnicas innovadoras del software.
Definiciones y acrónimos: Incluya definiciones con las que el cliente pueda no estar familiarizado, como términos técnicos, y también incluya una descripción de los acrónimos del software.

3. Completa la segunda parte del esquema

La segunda parte del esquema ofrece una descripción más detallada del proyecto y proporciona información sobre las posibles necesidades de software del usuario y los plazos del proyecto. Esto es lo que puede incluir en la segunda parte del esquema:

Descripción general: Esto da una descripción detallada del proyecto, como si el software es nuevo, si están añadiendo al software o si están cambiando el software existente.
Necesidades de los usuarios: Define quién puede utilizar el software descrito en el documento y cómo puede utilizarlo.
Dependencias: Esto ocurre cuando el equipo debe completar una tarea antes de completar otra, lo que hace que sea importante para el equipo completar cada tarea antes de la fecha límite.

4. Completar la parte final del esquema

La tercera parte del esquema ofrece información sobre los requisitos específicos del software. Los desarrolladores de software pueden trabajar con el cliente para crear estos requisitos, o pueden identificar problemas en el software anterior que les lleven a crear requisitos actualizados. Puede utilizar viñetas al enumerar cada característica y requisito. Esto es lo que puede incluir en la parte final de su documento de requisitos de software:

Características y requisitos del sistema: Esto incluye los requisitos de las características, incluidas las características específicas que pueden ayudar a la funcionalidad del software.
Requisitos de la interfaz externa: Estos requisitos ayudan a la funcionalidad y a que el nuevo software funcione bien con el software y la tecnología existentes. Puede incluir requisitos de software de front-end, back-end y de base de datos.

Relacionado: Habilidades de Desarrollo Front-End: Definición y ejemplos

Ejemplo de documento de requisitos de software

Estos son algunos ejemplos de documentos de requisitos de software:

Ejemplo 1

Este es un ejemplo de documento de requisitos de software para el proceso de guardado de archivos:

*1. Introducción: Este proyecto consiste en restaurar, guardar y abrir archivos para estudiantes universitarios. El plazo para la fase final de este proyecto es el 31 de mayo de 2022.*

*1.1: Objetivo: El propósito de este proyecto es hacer que los archivos sean más fáciles de abrir para los estudiantes, específicamente para los estudiantes que usan computadoras de escritorio en los campus universitarios. El objetivo de este proyecto es aumentar la funcionalidad de los ordenadores de sobremesa en los campus universitarios.*

*1.2: Audiencia: Los equipos de desarrollo de software uno y dos trabajarán en este proyecto, con varios directores de proyecto que supervisarán el proyecto y servirán de enlace entre el equipo de desarrollo de software y las partes interesadas del proyecto.*

*1.3 Uso previsto: El documento debe permanecer inalterado durante toda la duración del proyecto, a menos que un miembro del equipo reciba el permiso de un gestor de proyectos.*

*1.4 Alcance: Este proyecto permitirá a los usuarios abrir archivos con mayor rapidez, ya que la aplicación puede descargar archivos mientras están desconectados. También permitirá a los estudiantes conectar sus discos duros al ordenador más fácilmente, lo que puede permitir un mejor acceso a sus archivos.*

*1.5: Definiciones y acrónimos: Al referirse a los sistemas de archivos, mi equipo se refiere a los archivos informáticos que almacenan los datos que los estudiantes descargan y utilizan. «BFD» significa descriptor de archivo binario, «CIFS» significa sistema de archivos común de Internet, «CDFS» significa sistema de archivos de disco compacto y «EFS» significa sistema de archivos de encriptación.*

*2. Descripción general: Este proyecto implica el desarrollo e implementación de cambios en el software de archivos existente en los escritorios de la universidad. Se trata de solucionar problemas comunes relacionados con la apertura de archivos, el guardado de archivos y la restauración de archivos perdidos.*

*2.1 Necesidades del usuario: Los estudiantes universitarios pueden beneficiarse de este software, y pueden utilizarlo siempre que abran archivos, guarden archivos existentes o restauren archivos que hayan perdido previamente. Este cambio puede permitir un mayor espacio para los archivos y la prevención de pérdidas.*

*2.2 Dependencias: La primera fase del proyecto consiste en identificar los problemas del antiguo software que pueden causar problemas con los archivos, que debemos completar antes de pasar a la segunda fase, que consiste en desarrollar soluciones para cada problema. Tenemos previsto completar la primera fase del proyecto al final de la segunda semana del proyecto.

3. Características y requisitos del sistema:

Los usuarios deben ser capaces de abrir un archivo a los 20 segundos de hacer clic en él.
Los usuarios deben recuperar los archivos perdidos anteriormente buscando en una carpeta de basura a la que se transfieren automáticamente los archivos extraviados.
Los archivos deben archivarse inmediatamente después de que el usuario los guarde.
Los usuarios deben poder agrupar y distribuir los archivos según sus preferencias.

3.1 Requisitos de la interfaz externa:

Los programas informáticos deben ser compatibles con los ordenadores de sobremesa.
El software de back-end debe permitir una codificación que responda a la restauración de archivos.
El software de la base de datos debe permitir un espacio suficiente para almacenar y gestionar los archivos.

Ejemplo 2

Este es un documento de requisitos de software para potenciar la eficiencia de las aulas a distancia:

*1. Introducción: El software desarrollado a partir de este proyecto permite que los estudiantes de primaria tengan un acceso más fácil a las aulas en línea. La fecha límite para este proyecto es el 15 de diciembre de 2021.*

*1.1: Finalidad: El propósito de este proyecto es ofrecer a los estudiantes un software que les permita acceder a sus aulas en línea de forma más rápida y sencilla. El objetivo de este proyecto es que los niños tengan más independencia tecnológica en un entorno de aprendizaje a distancia.*

*1.2: Audiencia: El equipo de desarrollo de software 11 tiene acceso a este documento, junto con su director de proyecto.*

*1.3 Uso previsto: Los miembros del equipo pueden cambiar este documento sin permiso.*

*1,4 Alcance: Con el nuevo software, los estudiantes deberían entrar en su aula en dos minutos, incluyendo el tiempo de carga y conexión. Puede permitir que los estudiantes tengan que abrir menos documentos para acceder a su aula*.

*1.5: Definiciones y acrónimos: Al referirse a la tecnología educativa, los desarrolladores pueden utilizar el término «edtech,» y «D&T» se refiere al diseño y la tecnología.*

*2. Descripción general: Este proyecto consiste en crear e implantar un software en los ordenadores personales y en los de la escuela que permita a los estudiantes conectarse fácilmente a su aula de remoción. El proyecto mejora el software educativo existente mediante el uso de sistemas que permiten a los estudiantes saltarse páginas y sitios web innecesarios para acceder a su aula*.

*2.1 Necesidades del usuario: Los alumnos de primaria pueden beneficiarse de este software cuando se conectan a sus aulas o completan trabajos relacionados con la escuela en sus ordenadores. También pueden tener más acceso a la comunicación con los profesores cuando utilizan este software*.

*2.2 Dependencias: Una de las principales dependencias de este proyecto es la prueba del equipo una vez que los desarrolladores lo hayan completado. Los estudiantes deben probar el equipo para encontrar cualquier problema antes de poner el software en el mercado.*

3. Características y requisitos del sistema:

Los usuarios deben ser capaces de entrar en su clase después de encontrar un sitio web de inicio de sesión.
Los usuarios deben ser capaces de iniciar la sesión a los 30 segundos de introducir sus datos.
Los usuarios deberían poder establecer sus preferencias de inicio de sesión, incluida la hora a la que se conectan y su nombre de usuario y contraseña pregrabados.

3.1 Requisitos de la interfaz externa:

El software de entrada debe ayudar a los estudiantes a determinar fácilmente cómo iniciar la sesión utilizando elementos visuales y texto en negrita para dirigirlos a su aula.
El software de back-end debe utilizar una codificación que guarde sus datos de acceso.
El software de la base de datos debe extraer la información del usuario para identificar los tiempos normales de inicio de sesión.