====== Fábrica - Documentación Técnica de Productos de Software: Guía  ======
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 [[https://cs.uns.edu.ar/~ldm/mypage/data/oc/info/guia_para_la_documentacion_de_proyectos_de_software.pdf|Guía]] para las definiciones generales.

== Nota ==
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.

===== Definiciones =====
Este apartado debe cubrir los siguients aspectos:

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

==== Requerimientos ====
Debe cubrir:

  * Alcance
  * Limitaciones
  * Dependencias

==== Instalación de ambiente ====
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.  * 

===== Arquitectura Interna =====
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


  * [[ada:howto:sicoferp:factory:technicaldocumentationforsoftwareproducts:templategeneric|Guía para la documentación de productos de software]]

===== Documentación Técnica de Productos de Software =====

[[ada:howto:sicoferp:factory:technicaldocumentationforsoftwareproducts|←Volver atras]]