Esta sección define la plantilla básica que debe contener la documentación técnica de cada producto de software. Se toma como referencia la siguiente Guía para las definiciones generales.

Toda la infromación generada debe estar dirigida al público desarrollador de software por lo tanto se pueden ignorar o no incluir aspecto que no hagan parte de ese contexto.

Este apartado debe cubrir los siguients aspectos:

Descripción general del sistema o producto de software, proposito, objetivos y usuarios.

Debe cubrir:

• Alcance
• Limitaciones
• Dependencias

Este apartado debe cubrir los siguientes puntos:

• Repositorios: Descripcion de las ramas y rutas.
• IDE: Entornos de desarrollo utilizado y plugins.
• Versionamiento: Versiones utilizadas en el productos.
• Configuración del ambiente: Pasos para configurar el proyecto de software, ejecucion, compilación y despliegue. *

Este apartado esta enfocado a la estructura interna excluyen conceptos de arquitectura general del sistema. Se debe cubrir los siguientes puntos:

• Ítem de lista desordenada

• Guía para la documentación de productos de software

←Volver atras