...
- 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.
...
Para los diferentes tipos de API, los Miembros del equipo de desarrollo deberán documentar los métodos ofrecidos y la forma de acceso a los mismos en la sección Documentación técnica > APIs de servicios > REST | SOAP | RMI
En el caso de que sea una API REST o SOAP se deberá generar previamente la pertinente documentación con Enunciate o similar para enlazarla a la correspondiente ficha y también cualquier archivo o componente que sirva a las aplicaciones clientes para acceder al servicio (librerías, clientes ya generados, entidades, etc). Estos componentes deberán subirse a un entorno que permita añadirlos a su proyecto por parte de cualquier equipo de desarrollo.
...
Los Miembros del equipo de desarrollo deberán rellenar las secciones Documentación técnica > HOW TO TO y Documentación técnica > FAQ con la información que tengan a priori y la irán enriqueciendo conforme se usen las APIs de cara a tener la mayor información útil para los grupos de desarrollo.
...