...
Si en nuestro pórtico se generan proyectos que ofertan servicios a otros grupos vía REST, SOAP o RMI el el Responsable técnico asegurará que los Miembros del equipo de desarrollo documenten las diferentes APIs generadas de manera que cualquier grupo pueda utilizarlas sin dificultad. En el caso de que las API requieran autenticación gestionada por el proyecto, el Responsable técnico definirá el proyecto Jira al que los grupos clientes deberán registrar las solicitudes de alta de sus aplicaciones.
...
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.
A su vez los Miembros del equipo de desarrollo deberán asegurar que dicha información está actualizada, llevando un control de cambios y marcando los métodos que entren en desuso con la pertinente etiqueta. El Responsable técnico deberá comprobar el estado de dicha documentación antes de cada actualización del proyecto o proyectos incluidos en el pórtico. También deberá notificar a todos los grupos los cambios en cada versión de la API para planificar las actualizaciones que sean necesarias en las aplicaciones clientes,.
También los Miembros del equipo de desarrollo deberán rellenar las secciones Documentación técnica > HOW 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.
Los grupos externos deberán registrar como comentarios en la sección FAQ las cuestiones que les hayan ocurrido y los Miembros del equipo de desarrollo trasladarán la pegunta/respuesta a la FAQ borrando el comentario que la originó para no meter ruido.