Documentación de Software

Documentación de Software

1. Definiciones y especificación de requerimientos

   • Propiedades o restricciones que deben satisfacerse
     • Definición general del proyecto de software
       • ¿En qué consiste el sistema o desarrollo?-¿cuál es la idea general? - ¿cuál es la funcionalidad?
         • Propósitos
         • Objetivos
         • Idea general
         • Usuarios
     • Especificación de requerimientos del proyecto
       • Detalle de los requerimientos técnicos y generales
         • Alcance
         • Limitaciones
         • Requisitos generales
         • Requisitos funcionales
         • Información de autoría
         • Información de Legacy
   • Especificaciones de procedimientos
     • Procedimientos de desarrollo
       • Herramientas utilizadas
       • Planificación
     • Procedimiento de instalación y pruebas
       • ¿cómo se realiza la obtención, instalación y/o prueba del sistema?
         • Especificaciones de la plataforma o entorno donde debe ser ejecutado
           • Requisitos no funcionales
           • Obtención e instalación
             • Una guía sencilla que explique el procedimiento básico para obtener e instalar el sistema.
               • Dirigida a los usuarios con nivel de experiencia preestablecido en la definición general del proyecto
           • Especificaciones de prueba y ejecución

2. Arquitectura del sistema

   • Descripción jerárquica
   • Diagrama de módulos
   • Descripción individual de los módulos
     • Descripción general y propósito: ¿qué es y qué debería hacer el módulo?
     • Responsabilidad y restricciones: ¿cuál es su función específica dentro del sistema? ¿qué cosas puede y no puede hacer?
     • Dependencias: Indicar cuales son los requisitos del módulo, ¿qué necesita o requiere el módulo para funcionar? ¿necesita de servicios brindados por otros módulos o por librerías externas?
     • Implementación: indicar en qué archivo o archivos se encuentra la implementación del módulo.
   • Dependencias externas
   • Aspectos técnicos o tecnologías empleadas
     • Lenguajes de programación
     • Frameworks
     • Librerías

3. Diseño del modelo de datos

   • Entidades involucradas en el sistema
     • Formato languageagnostic
     • Datos de entrada
     • Datos internos
     • Datos de salida

4. Descripción de procesos y servicios ofrecidos por el sistema

   • ¿cuáles son los servicios o tareas que el sistema ofrece/implementa?
     • pseudo-algoritmos
     • Diagramas de flujo
     • Lenguajes de programación

5. Documentación técnica - Especificación API

   • Manual del programador
     • Propósito y breve descripción de cada método/función
       • Argumentos
         • Nombre
         • Tipo
         • Propósito
       • Respuesta
         • Tipo
         • Descripción