0. Introducción

El objetivo de la elaboración de la documentación técnica del proyecto es facilitar al resto de grupos a acceso a la información del mismo que va a ser utilizada por dichos grupos. En este espacio deberemos indicar las APIs que se ofertan, los componentes y cualquier información relevante que sea de utilidad para los grupos que quieran acceder a la información ofertada.

También es imprescindible definir claramente el modo de acceso (público y/o autenticado) y los mecanismos que se utilizarán para ello.

1. Componentes

Si durante el desarrollo del proyecto se han creado componentes reutilizables por el resto de los grupos el Responsable técnico y/o los Miembros del equipo de desarrollo deberán dejar disponibles los componentes y documentarlos para su reutilización por el resto de los grupos. Para ello el Responsable técnico supervisará que se realizan las siguientes acciones por parte de los  Miembros del equipo de desarrollo.

• Configurar el componente para ser incluido en un proyecto, desacoplándolo de cualquier lógica no relacionada con él mismo.
• Registrar el componente para que sea descargado y reutilizado por el resto de los grupos usando: Maven, Verdaccio, etc.
• Añadir la documentación del componente al apartado Documentación técnica > Componentes. En caso de no tener en nuestro espacio dicha estructura podemos copiarla desde la plantilla de espacio de pórtico.
• Una vez añadido y documentado se deberá probar la inclusión en un proyecto siguiendo los pasos indicados, a ser posible por una persona que no conozca en profundidad el componente para poder validar la documentación.