La documentación, adentrándose dentro del UP - BPM & Proyectos

La documentación, adentrándose dentro del UP

Estando ya cristalizado la idea del proyecto, se debe empezar a formalizar y llevar a ejecución. Para tomar el control y asegurar la continuidad de la organización del proyecto respectos los cambios del mismo, se debe implementar en el un proceso de fabricado, UP (Proceso Unificado) es un estándar para ello, en las empresas hoy día se aplica sobre RUP, sin embargo la mayoría de las etapas son comunes, hay dos que son importantes: la documentación y la gestión de calidad.

La gestión de calidad comienza desde el primer momento que la documentación se empieza cristalizar, el equipo encargado de esto debe trabajar muy de cerca con el equipo de ingenieros que diseñan y construyen los artefactos de software así como la gerencia que define la funcionalidad de estos.

Involucrados en las etapas iniciales

En esto hay tres actores involucrados, los Gerentes, que junto con, los Ingenieros, definen las funcionalidades del proyecto y los artefactos de software resultantes, los ingenieros a partir de estos crean los preliminares técnicos. El equipo de Aseguramiento de Calidad o Calidad, trabaja paralelo, y en un principio en conjunto, es el que se asegura todo se paute según lo acordado, es el policía de turno entre las partes.

El resultado de todo el trabajo realizado entre estos tres primeros equipos de participantes son los Documentos Funcionales y los Documentos Técnicos, las dos piezas fundamentales que ayudaran a construir el producto resultante de la realización de dicho proyecto cualquiera.

Documento funcional

El documento funcional define la utilidad y valor agregado desde el punto de vista humano y gerencial, el cual dará por medio de la abstracción (imaginando el producto final insofacto), utilidad y funciones adicionales o nuevas a determinadas tareas existentes o no existentes necesarias para la empresa o un fin determinado.

Este documento se ve desde dos punto de vista (que en empresas grandes se discuten por separado), el gerencial, el cual enfoca el valor monetario y agregado a la empresa; y el humano, el cual por medio de un lenguaje entendible discute lo que el proyecto cristalizara para la empresa o fin convenido necesario.

Es el primer artefacto que se fabrica en un proyecto en general, y ayuda a definir los distintos niveles de documentos técnicos necesarios para el desarrollo de los artefactos de software.

Los documentos funcionales definen las ideas y las plasman ayudando a no desviar dicho proyecto de las metas pautadas. Un proyecto sin documento funcional, es como una petición de algo sin tener las ideas claras y plasmadas para poder decir que ya están definidas.

Documento técnico.

El documento técnico surge de los varios análisis por parte del equipo de ingenieros durante las etapas venideras después de realizados los documentos funcionales.

Los documentos técnicos definen a nivel de desarrollo, que se deberá realizar para llevar a cabo las ideas plasmadas en los documentos funcionales. Aunque esto no siempre es así, se dice esto en términos generales.

Estos documentos se fabrican en etapas posteriores y aquí intervienen dos actores participantes, el mismo equipo de Ingenieros lideres del proyecto, que previamente definieron los funcionales (en reuniones con los Gerentes); y los Recursos, que son equipos de desarrolladores, algunos lideres de sub equipos por cada parte de artefacto de software a fabricar.

Base de documentación y trabajo colaborativo, requisitos obligatorios

Ya para estas etapas iniciales se debe de tener un Artefacto para Gestionar el Proyecto, ya que debe haber una base de documentación accesible por las partes involucradas. Es obvio que los niveles de accesibilidad son distinto por razones implícitas de políticas propias por la empresa, un recurso no debe saber nada de los cambios a nivel gerencial, para eso esta dentro de el equipo de ingenieros su lider de proyecto, el cual interpretara lo necesario y le proporcionara tareas por medio del software de gestión.

Este Software Gestor de proyectos, permite organizar los roles participantes, así como trabajar de manera colaborativa, requisito necesario para terminar rápidamente estas primeras etapas que son las mas difíciles.

Definiciones, Formatos y estandares

Los documentos a generar, deben tener un formato, ademas deben estar versionados.

Las platillas son archivos esenciales que ayudan a esto, se emplean en los software de oficina, al abrir una plantilla predefinida esta tiene ya escrito una estructura.

Se deben definir plantillas ofimáticas para la realización de estos documentos. Esto ayuda a formalizar la documentación y agilizar el trabajo entre las partes. 

Ademas permite que los recursos de las etapas secundarias los cuales no se enfocan en el trabajo ofimática, ahorren tiempo solo rellenando las entradas de texto necesarias indicadas por estos formatos de plantillas.

Se provee aquí: DocumentoFuncional.ott un ejemplo de plantilla para un documento funcional desde cero, con algunas notas de ayuda. Al abrirla, y empezar a llenarla, deberá guardarla, aquí el software ofimática preguntara el nombre del archivo y se producirá el primer documento funcional-técnico por su parte.

Lineamientos y definiciones de trabajo en los archivos de documentos:

  • Deben tener todos en la cabecera un código que relacione el proyecto dentro de la empresa.
  • En el pie de pagina debe tener el nombre del departamento involucrado
  • En las paginas segunda o tercera debe haber un cuadro referenciando los documentos relacionados necesarios para poder entender los temas citados o implicados en el mismo.
  • Al guardar el documento, no se debe dejar espacios en el nombre del archivo.
  • Todos los documentos deben tener encendido el sistema de grabación de versiones, para el trabajo colaborativo entre las partes involucradas.
  • Tener un glosario de términos o palabras empleadas.

Sistema de versionado del software ofimatico.

Este se activa desde el menu de "Ediccion", un elemento de menu que dice "Cambios". En sistemas privados licenciados esta en un menu especial de "Revisiones". En sistemas mas pequeños se encuentra de la misma manera, en un menu especifico llamado "Colaborar".

Practicante consta de tres cosas, activar el versionado o grabar, ver los cambios y gestionarlos, no es muy difícil, "jugando un poco" se llega entender esto.

No Comment