Universidad Manuela Beltrán

Equipo de investigación UMB – Virtual

Ensayo documentación del software

Realizado por:
Eric Yesid Aponte Torres

Marzo 2020
 Abstract

En el presente documento se construye y describe los diferentes formatos y estándares de la

documentación de software de manera general; Donde entablaremos como ejemplo Software
Development Plan (SDP), Software Requirements Specifications (SRS), Software Design Documents
(SDD) y Software Test Documents (STD) los cuales establecen una documentación técnica y funcional
del software donde se presenta su arquitectura y construcción dentro de su ciclo de vida.

fferent formats and protocols of the software documentation in a general way; Where we will set as
an example Software Development Plan (SDP), Software Requirements Specifications (SRS), Software
Design Documents (SDD) and Software Test Documents (STD) which require a technical and functional
documentation of the software where its architecture and construction is presented within its life
cycle.
 www.umbvirtual.edu.co

Contenido
Abstract........................................................................................................................................................2
Capítulo 1......................................................................................................................................................4
Introducción e información general.........................................................................................................4
Capítulo 2......................................................................................................................................................5
Software Development Plan (SDP)...........................................................................................................5
Software Requirements Specifications (SRS)............................................................................................7
Software Design Documents (SDD)..........................................................................................................8
Software Test Documents (STD)...............................................................................................................9
Capítulo 3....................................................................................................................................................11
Resultados y discusión:...........................................................................................................................11
Referencias.................................................................................................................................................12

3
 Capítulo 1

Introducción e información general

La documentación es requerida dentro del ciclo de vida del software en todas sus etapas ya que es de
importancia tener descrito desde el inicio un requerimiento o alcance que permita establecer que es
lo que se quiere construir y que funcionalidades cumpliría el software; Adicionalmente dependiendo
del tipo de metodologías que se requiera se presentara una documentación por fases o una inicial y
final. La documentación por fases expresa lo realizado desde el ámbito funcional, técnico y de
pruebas al igual si es una documentación final la cual describe todo lo realizado en el software.
 www.umbvirtual.edu.co

Capítulo 2

Software Development Plan (SDP)

El SDP proporciona al cliente la información funcional y técnica para monitorear el proceso a seguir
para el desarrollo de software. También detalla los métodos, metodologías, requisitos, restricciones,
estrategias, prototipos, análisis de riesgos, estándares que se utilizarán y el enfoque que dará el
desarrollador hacia el software.

A continuación se describe la composición general de lo que requiere un SDP:

 Introducción al plan y descripción general. (Se determina el alcance de lo que se quiere del
software)

5
 o Propósito, alcance y objetivos.

o Suposiciones y Restricciones.

 Documentos de referencia.(Establece las propiedades de otros software en los cuales se

puede basar)

 Definición de términos y siglas. (Terminos y siglas manejadas en el documento)

 Descripción general del sistema, incluida la arquitectura del sistema y el software. (Describe de
manera técnica y funcional el software)

 Descripción general del trabajo requerido, que incluye:

o Requisitos y restricciones sobre el sistema y el software a desarrollar.

o Productos de software y productos relacionados.

o Requisitos y restricciones en la documentación del proyecto.

o El programa / estrategia de adquisición, recursos y horarios

o Requisitos y restricciones adicionales, como la seguridad del proyecto, la privacidad, los

métodos, los estándares, las interdependencias en el desarrollo de hardware y
software.

o Riesgos específicos de software conocidos.

 Organización del proyecto y recursos:

 Planes para realizar actividades generales de desarrollo de software, que incluyen:

o Procesos de desarrollo de software.

o Enfoques de desarrollo de software

o Métodos de desarrollo de software.

o Estándares de desarrollo de software

o Productos de software reutilizables y  comercial-off-the-Shelf (COTS)

 www.umbvirtual.edu.co

o Tipos / categorías de software (es decir, software operativo, software de prueba,

software de equipos de soporte) y procesos, controles y documentación asociados.

o Manejo de requisitos críticos (como seguridad y seguridad de la información).

o Enfoque de desarrollo incremental, planificación y gestión / supervisión.

o Establecimiento del sistema / entorno de ingeniería de software.

o Utilización de recursos informáticos y capacidad de reserva / gestión del crecimiento.

  Procesos de desarrollo relacionados con el software, que incluyen:

o Metodología de desarrollo general.

o Prototipos y simulaciones.

o Análisis y diseño de requisitos del sistema, incluida la definición y asignación de

requisitos

o Análisis de requisitos de software.

o Diseño preliminar y detallado de software.

o Unidad de software de integración y pruebas.

o Integración y prueba de componentes de software.

 Procesos e información de apoyo, que incluyen:

o Software de gestión de riesgos.

o Enfoque de trazabilidad de requisitos.

Software Requirements Specifications (SRS)

Un SRS describe de manera funcional lo que el software necesita para satisfacer todas las necesidades
de los interesados (Cliente y usuario). Utilizado para proporcionar información crítica a el equipo de

7
desarrollo, garantía de calidad, operaciones y mantenimiento proporcionando la contextualización de
lo que se requiere.

El SRS está constituido principalmente de la siguiente manera:

1. Introducción (Se describe la problemática y una breve información del software)

1.1 Propósito (Se establece la solución a la problemática del documento sobre el software a realizar)

1.4 Alcance (Se determina el alcance para el desarrollo del software)

1.5 Definiciones y acrónimos (Descripción y definición de palabras y acrónimos encontrados en el

documento)

2. Descripción general (Describe la funcionalidad del software)

2.1 Necesidades del usuario (Establecen los requerimientos de lo que desea el usuario)

2.2 Suposiciones y dependencias (Vista a futuro de lo que requiere el software para su

funcionamiento orientado a sus dependencias como pueden ser de infraestructura o arquitectura)

3. Características y requisitos del sistema (Se establecen los minimos requisitos y características que
debe tener el software)

            3.1 Requisitos funcionales

            3.2 Requisitos de interfaz externa

            3.3 Características del sistema

            3.4 Requisitos no funcionales

 Software Design Documents (SDD)

La información que proporciona el documento de diseño de software describe el tipo de software que
se está desarrollando, metodología y arquitectura utilizada para su desarrollo. El estándar más
utilizado es el IEEE, que actúa como un marco general que se muestra a continuación:
 www.umbvirtual.edu.co

1. Introducción (se establecen los objetivos y alcance del software a desarrollar orientado a la
solución de la problemática)

1.1 Propósito

1.2 Alcance

1.3 Descripción general

1.4 Material de referencia

1.5 Definiciones y acrónimos

2. Descripción general del sistema (se defina la funcionalidad del software)

3. Arquitectura del sistema (describe de manera técnica la arquitectura del software y sus
dependencias)

3.1 Diseño arquitectónico

3.2 Descripción de descomposición

3.3 Justificación del diseño

4. Diseño de datos (presenta un modelo de datos orientado a la creación de la base de datos y su

almacenamiento)

4.1 Descripción de datos

4.2 Diccionario de datos

5. Diseño de componentes (se visualizan los diagramas de acuerdo a las funcionalidades, casi siempre
es en uml)

6. Diseño de interfaz humana (diseños de la interfaz a la que tendrá acceso el usuario final)

6.1 Descripción general de la interfaz de usuario

6.2 Imágenes de pantalla

6.3 Objetos de pantalla y acciones

9
7. Matriz de requisitos (se presentan los requisitos de infraestructura y técnicos para el software)

Software Test Documents (STD)

La documentación de pruebas para software es requerida para establecer los planes y casos de
prueba a ejecutar de tal manera que determinen una alta calidad del software desarrollado y cumpla
con el alcance planteado desde un inicio. ISO / IEC / IEEE 29119-3 proporciona plantillas para la
documentación de pruebas que cubren todo el ciclo de vida del software; Las plantillas que se definen
en ISO / IEC / IEEE 29119-3 son los siguientes:

Documentación del proceso de prueba organizacional: (Define los tipos de pruebas y su calificación)

- Política de prueba

- Estrategia de prueba organizacional

Documentación del proceso de gestión de pruebas: (Estrategias de mejora y seguimiento durante la

ejecución de las pruebas)

- Plan de prueba (incluida una estrategia de prueba)

- Informe de estado de prueba

- Informe de finalización de prueba

Documentación del proceso de prueba dinámica: (Se establecen las pruebas que deben ser
competentes y orientadas a los requerimientos y casos de uso establecidos para el desarrollo del
software)

- Especificación de diseño de prueba

- Especificación de caso de prueba

- Especificación del procedimiento de prueba

- Requisitos de datos de prueba

- Informe de preparación de datos de prueba

- Requisitos del entorno de prueba

- Informe de preparación del entorno de prueba

 www.umbvirtual.edu.co

- Resultados actuales

- Resultado de la prueba.

- Registro de ejecución de prueba.

- Informe de incidentes de prueba.

11
 Capítulo 3

Resultados y discusión:

La importancia de la documentación de un software durante el ciclo de vida determina una medición

y estrategia para el planeamiento y cubrimiento de los requerimientos y alcances establecidos de tal
manera que sea consecuente de lo que requería el usuario final. Adicionalmente la documentación de
software proporciona una traza técnica y funcional donde se describe cada componente y tecnología
utilizada para su realización lo que determina una ayuda por su se requiere un control de cambios al
software.
 www.umbvirtual.edu.co

Referencias

 Guía de gestión de software de sistemas de armas de la USAF - Apéndice I - recuperado de:

http://www.acqnotes.com/Attachments/USAF%20Weapon%20System%20Sofware
%20Management%20Guide.pdf
 Mil-STD-498 "Desarrollo de software y documentación" - 5 de diciembre de 1994 – recuperado
de: http://www.acqnotes.com/Attachments/Mil-STD%20498%20%E2%80%9CSoftware
%20Development%20and%20Documentation%E2%80%9D%2005%20Dec%201994.pdf
 Mil-STD-498 "Guía de aplicación y referencia" - 3 de enero de 1996 – recuperado de
http://www.acqnotes.com/Attachments/MIL-STD-498%20%E2%80%9CApplication%20and
%20Reference%20Guidebook%E2%80%9D%203%20Jan%201996.pdf
 Software Design Documentation (SDD) BY DINESH THAKUR - recuperado de
http://ecomputernotes.com/software-engineering/softwaredesigndocumentation
 829-1983 - IEEE Standard for Software Test Documentation Publisher: IEEE 829-1998 -
recuperado de https://ieeexplore.ieee.org/document/573169
 Pruebas de software ISO / IEC / IEEE 29119 - recuperado de
https://www.softwaretestingstandard.org/part3.php

13