top of page

Documentación de proyectos de software.


1. Definiciones y especificación de requerimientos.

Los requerimientos/requisitos de un sistema describen los servicios que ha de ofrecer el sistema y las restricciones asociadas a su funcionamiento, es decir, las propiedades o restricciones que deben satisfacerse, determinadas de forma precisa.

En este apartado se brindarán tres aspectos informativos:

a) Definición general del proyecto de software: explicar en qué consiste el sistema o desarrollo en cuestión, cuál es la idea general y la funcionalidad principal del proyecto de software, así como también los propósitos y objetivos del desarrollo.

b) Especificación de requerimientos del proyecto: incluir el detalle de los requerimientos técnicos y generales del mismo, los alcances y limitaciones de la implementación realizada. Deberá aclararse si el proyecto de software forma parte de algún sistema ya desarrollado; de ser el caso, especificar si se desarrolló una nueva versión o es una derivación.

c) Procedimientos de instalación y prueba: detallar cómo se realiza la obtención, instalación y/o prueba del sistema, junto las especificaciones generales de la plataforma o el entorno sobre el cual el software debe ser ejecutado.

DEFINICIÓN GENERAL DEL PROYECTO DE SOFTWARE.

En la definición del proyecto se deberá brindar detalle sobre los puntos que se definen a continuación:

Idea general: la funcionalidad principal del sistema (qué..?) ● Objetivos: los objetivos del desarrollo, y la necesidad cubierta por el sistema en cuestión (para qué..?) ● Usuarios: las personas o entidades que utilizarán el sistema o parte de él, y el nivel de experiencia del usuario hacia el cual el presente informe está dirigido (quién..?)

ESPECIFICACIÓN DE REQUERIMIENTOS DE SOFTWARE.

Dentro de la especificación de requerimientos se dará información del proyecto de software sobre los siguientes puntos:

Requisitos generales: las pautas y consignas que sigue el proyecto de software. ● Requisitos funcionales: los servicios que el sistema proporciona, las tareas que éste desarrolla. ● Información de autoría y Legacy del proyecto: explicitar si el proyecto de software forma parte de desarrollos previos/preexistentes o si es original, y en el caso correspondiente, detalles de retro-compatibilidad. ● Alcances del sistema: las limitaciones y alcances del desarrollo, de acuerdo a los objetivos previamente establecidos.

ESPECIFICACIONES DE PROCEDIMIENTOS.

Dentro de la información relativa a procedimientos se distinguirá:

Procedimientos de desarrollo: ● Herramientas utilizadas: entornos de desarrollo integrados, plataformas y herramientas empleadas en la implementación del sistema. ● Planificación: una descripción global de la metodología utilizada para encarar y resolver el problema; por ejemplo: los pasos ejecutados a lo la