Tabla de contenido 1. OBJETIVOS... 2 2. ASIGNACION DE RESPONSABILIDADES... 2 3. ROLES Y TAREAS... 3 4. ALCANCE... 4 5. PROCEDIMIENTOS RELACIONADOS... 4 6. DOCUMENTOS RELACIONADOS... 4 7. PROCESO... 4 7.1. Proceso para un nuevo proyecto o una migración de un sistema existente... 4 A. ANALISTAS... 4 B. DESARROLLADORES... 6 8. REVISION HISTORICA... 7 9. LISTA DE DISTRIBUCION... 8 PR-P-DEPR_001 Procedimiento para documentación de sistemas 1 de 8
1. OBJETIVOS Establecer un procedimiento para normalizar la documentación asociada a cada proyecto dentro de la Coordinación. De esta forma los distintos proyectos poseerán una documentación mínima necesaria y uniforme asociada, de forma de cumplir con la Resolución 48/07 de SIGEN. 2. ASIGNACION DE RESPONSABILIDADES Será responsabilidad del Coordinador de Gestión Técnica: Generar la inclusión del proyecto en el Plan Estratégico de la Coordinación. Obtener del usuario solicitante, el pedido formal del proyecto. Tomar conocimiento periódicamente del avance de los proyectos. Será responsabilidad del Responsable de los distintos proyectos Verificar la existencia de la nota formal ó la inclusión del proyecto en el Plan Estratégico de la Coordinación. Proveer a analistas y desarrolladores de los recursos necesarios para el cumplimiento del presente procedimiento. Designar al analista funcional a cargo del proyecto, mediante la remisión del pedido formal ó mail solicitando el proyecto. Designar al desarrollador ó los desarrolladores que intervendrán en el desarrollo realizando la comunicación formal mediante mail. Realizar un seguimiento de la documentación y avances del mismo durante la duración del proyecto. Informar al Coordinador de Gestión Técnica los avances del proyecto. Será responsabilidad de los Analistas: Realizar el relevamiento y análisis según pedido realizado vía mail por el Responsable del Proyecto. Llevar a cabo el desarrollo asignado, teniendo en cuenta la existencia de módulos ó proyectos que interactúan ó pudieran interactuar con éste. Construir el plan de proyecto, plan de implantación y plan de capacitación. Informar periódicamente el avance del proyecto al Responsable de Proyectos. En todos los casos cumpliendo con el procedimiento y la documentación descripta en el punto 4. Será responsabilidad de los Desarrolladores: Responder a la propuesta elevada por el analista. Construir el modelo de datos que se inserte en el modelo general del Senasa. Generar líneas de código para la construcción del proyecto. Realizar y versionar las pruebas primarias del sistema generado. Asistir al analista en la implantación y capacitación. En todos los casos cumpliendo con el procedimiento y la documentación descripta en el punto 4. PR-P-DEPR_001 Procedimiento para documentación de sistemas 2 de 8
3. ROLES Y TAREAS Roles Analistas Desarrolladores Usuario final Responsable test y producción QA Tareas Levantar requerimientos ( relevamiento usuario final) Generar minutas de reunión Análisis de requerimientos Definición de casos de uso Especificación funcional y no funcional Diseño de pantallas Definición de roles y accesos a la aplicación Definición DER Planificación y control de actividades Testing unitarios Documentación manual de usuario Generar informes de avance Capacitación usuario final Registración de bugs y mejoras de las aplicaciones Implementación DER Refinamiento arquitectura candidata Desarrollo en general Documentación implementación Versionamiento Testing unitario Desarrollo en cuanto a mejoras o arreglos de bugs Registrar en la wiki buenas prácticas de desarrollo o nuevas funcionalidades Cierre de tickets antes bug o mejoras notificadas Enviar nota de pedido Testing final Aceptación del producto ( recepción nota de cierre ) Ejecutar tickets de pedidos según ambientes Notificación de implementaciones realizadas Cierre de tickets Rollback ante incidentes Migración de datos en general Aplicar parches o mejoras a nivel de OS, DB y AS Testing unitario Documentación pruebas realizadas Análisis de performance Sugerencias en cuanto a mejoras en general Detectar accesos no permitidos Estresar la aplicación Validar la correcta migración de datos PR-P-DEPR_001 Procedimiento para documentación de sistemas 3 de 8
Roles Project Manager Tareas Generar informes de avance Asignación de recursos y tareas Control de tiempos, recursos y documentación de proyectos, etc Implementar mejoras que agilice y ordene los proyectos en general Mentoring en general Dar visibilidad al usuario final en cuanto a tiempos Solucionar problemas técnicos en general Definir estrategias de migraciones e implementación del proyecto 4. ALCANCE Este procedimiento se aplicará a todo desarrollo de sistema, modificaciones o migraciones realizados por la Coordinación de Gestión Técnica. 5. PROCEDIMIENTOS RELACIONADOS No tiene 6. DOCUMENTOS RELACIONADOS Resolución 48/07 SIGEN Templates para generar la documentación del proyecto (http://gta.senasa.gov.ar/mediawiki/index.php/gestión_de_proyectoswiki - Templates Etapas del proyecto) Metodología de Trabajo (http://gta.senasa.gov.ar/mediawiki/index.php/portada - Gestión Interna - Metodología de Trabajo). Flujo de Procesos en Ambientes de trabajo (http://gta.senasa.gov.ar/mediawiki/index.php/portada - Gestión Interna - Flujo de Procesos en ambientes de trabajo). 7. PROCESO 7.1. Proceso para un nuevo proyecto o una migración de un sistema existente A. ANALISTAS Tomar las plantillas de artefactos necesarios de la siguiente dirección: http://gta.senasa.gov.ar/mediawiki/index.php/gestión_de_proyectos, usuario y contraseña son los provistos para el uso del mail. Debe poseer una contraseña para depositar el proyecto en el servidor GTA/SENASA. PR-P-DEPR_001 Procedimiento para documentación de sistemas 4 de 8
Crear una carpeta con el nombre del proyecto en: \\gta.senasa.gov.ar\proyectos\nombredelproyecto. Allí se deben volcar los diferentes documentos cumplimentados por el analista del proyecto, en las distintas etapas del mismo. Las diferentes etapas con sus documentos asociados son las siguientes: Se debe armar una subcarpeta dentro de la carpeta nombredelproyecto con el nombre Inicial, en la misma se deben volcar los siguientes artefactos cumplimentados, como mínimo los obligatorios: Minuta de reuniones (No obligatorio) Requerimiento del usuario (No obligatorio) Propuesta de proyecto (obligatorio) firmada por el usuario. La misma debe ser escaneada y depositada dentro de la carpeta correspondiente. Se debe armar una subcarpeta dentro de la carpeta nombredelproyecto con el nombre Elaboración, en la misma se deben volcar los siguientes artefactos cumplimentados, como mínimo los obligatorios: Conjunto de casos de uso (obligatorio) Descripción detallada de cada CU (obligatorio) Test funcional CU (obligatorio sólo en los principales CU) Diagrama de actividad (obligatorio) Se debe armar una subcarpeta dentro de la carpeta nombredelproyecto con el nombre Construcción, en la misma se deben volcar los siguientes artefactos cumplimentados, como mínimo los obligatorios: Plan de Pruebas (obligatorio). Aceptado y firmado por el usuario. Plan de Implantación (obligatorio) Plan de Capacitación (obligatorio) Se debe armar una subcarpeta dentro de la carpeta Proyecto con el nombre Implementación, en la misma se deben volcar los siguientes artefactos cumplimentados, como mínimo los obligatorios: Manual de Usuario (obligatorio) Realizar el análisis del proyecto completando los artefactos mínimos descriptos anteriormente. Guardar los diferentes artefactos cumplimentados en la carpeta nombredelproyecto creada en \\gta.senasa.gov.ar\proyectos\nombredelproyecto siguiendo los diferentes pasos descriptos. El avance del proyecto se debe registrar en el DOT PROYECT. Los Bugs ó mejoras se deben registrar en el MANTIS. PR-P-DEPR_001 Procedimiento para documentación de sistemas 5 de 8
B. DESARROLLADORES Organización código fuente: Definir estructura de directorio ( librerías, iconos, menú, etc ) Nombre y versión de las librerías utilizadas Descripción paso a paso para el seteo inicial de la aplicación a los efectos de permitir su ejecución (configuración webservice, mapeo de servidores de seguridad, etc ). Incluir en el código documentación detallada, siguiendo los estándares del lenguaje utilizado. Diagrama de objetos: Descripción gráfica los objetos, atributos y métodos que se utiliza en la aplicación construida, los mismos tienen que estar agrupados por caso de uso en los cuales se los referencia, si correspondieran a más de un caso de uso, deberán ser descriptos en el de mayor relevancia y citados en los restantes. Diagrama transición de estados: Descripción de las acciones que dispara cada objeto y la forma en que se comunican, las mismas tienen que estar implementadas en forma gráfica por cada caso de uso. Diagrama de Entidad Relación (DER): Descripción gráfica del modelo físico de datos, implica mostrar tablas, relaciones, atributos, etc. Nombre del esquema donde deben que estar los objetos. Roles y permisos, si es necesario. Descripción para el deploy de las aplicaciones: En los distintos ambientes, describir los cambios que tiene implementado cada versión del SVN, pasos para la compilación y seteo de archivos de configuración para ejecutar en los distintos ambientes. Descripción de roles y accesos: Implica describir por rol los objetos a los que tiene acceso y si los mismos pueden ser simultáneos. PR-P-DEPR_001 Procedimiento para documentación de sistemas 6 de 8
8. REVISION HISTORICA Fecha Versión Motivo PR-P-DEPR_001 Procedimiento para documentación de sistemas 7 de 8
9. LISTA DE DISTRIBUCION Apellido y Nombre del Agente Asiento de funciones Fecha Firma PR-P-DEPR_001 Procedimiento para documentación de sistemas 8 de 8