Documento del Proceso (II)

Según las practicas comunes en cada lugar u organización, los elementos comunes de los documentos vienen dispuestos en distintos lugares del mismo. Un ejemplo de esto es el Indice de Contenido, el cual suele colocarse de primero o en las primeras páginas del documento en Venezuela y otros países de habla española, en tanto que en USA muchas veces es colocado de ultimo.

Diferencias como la anterior no nos deben llamar a la admiración ni constituire en un problema. De todos modos, cada artefacto del proceso, e incluso el proceso mismo de cada organización debe ser adaptado a sus propias necesidades y costumbres, por lo que tener el indice en un lugar distinto al sugerido en metodologías como RUP es algo muy natural.

Por otro lado, si bien la disposición de los elementos comunes puede variar, debería tenerlos en algún sitio bien definido de sus documentos, ya que recogen información útil sobre los pasos del proceso.

Finalmente, una lista parcial de elementos para que los tenga en consideración:

  • Identificación del documento: Título, Proyecto y Versión.
  • Identificación del autor: Nombre e información de contacto.
  • Identificación de quien aprueba, en caso de requerirse una aprobación.
  • Historial de versiones del documento.
  • Glosario de términos utilizados.
  • Glosario visual de los iconos utilizados.
  • Alcance del documento, esto es, identificar que parte del proceso o del sistema que se cubre en el documento. Por ejemplo Arquitectura del Sistema: Módulo de Atención al Cliente.
  • Artefactos tomados como entrada, indicando nombre y versión.
  • Artefactos generados como derivados, indicando nombre.
  • Anexos.
  • Indice de Contenido.
  • Indice de Figuras.
  • Indice de Tablas.

De la lista anterior, tome lo que considere que se justifica para su organización. Es importante que mantenga el alcance del documento, así como la relación de artefactos en entrada y salida, ya que esta información le ayuda más adelante con las trazas de requisitos.

Coloque los nombres de las secciones y escriba pequeñas secciones de introducción a cada sección. Añada además las notas e indicaciones para los futuros usuarios de su plantilla. Recuerde que estas plantillas serán llenadas por seres humanos, por lo que las indicaciones en cuanto a estructura, forma y contenido que pueda ir planificando desde ahora le harán la vida más sencilla en un futuro. Todo esto será de utilidad cuando intente en realidad hacer su trabajo con ayuda de la documentación que produzca.

, ,

  1. Deja un comentario

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: