Plan de Documentación

Un Plan de Documentación describe los medios que se pondrán a disposición del esfuerzo de documentación del proyecto de desarrollo. Entre otros medios, podemos imaginarnos recursos tales como plantillas, redactores técnicos, guías de estilo, procesadores de texto, etc.

Es sin duda un plan simple, en el sentido en que puede considerarse completo con relativamente poca extensión. Sin embargo es también un típico plan dejado solo para las organizaciones más maduras, ya que muchos simplemente dejan a su esfuerzo de documentación sin planificación alguna.

La creación de documentos completos y útiles no es un arte; es una práctica esencial de la ingeniería y como tal, debe ser vista como algo rutinario, sistematizado con herramientas y en la medida de lo posible, agilizado.

En el espíritu de la agilidad, lo mejor es planificar medios para documentar los aspectos técnicos del proyecto en herramientas de modelado UML[1], prefiriendo estas a los reportes tradicionales que obligan a un mayor trabajo de edición. También es interesante explorar la posibilidad de utilizar técnicas alternativas de documentación, como las Wikis que permitan crear y utilizar la documentación en formas más rápidas.

Otro aspecto a documentar aquí, es el formato de archivo o formatos, que se van a utilizar. Quizás una organización pueda preferir tener sus documentos en formato ODT[2] de OpenOffice, o bien el formato RTF, o quizás en HTML; entre otras muchas posibilidades. La elección puede facilitar mucho el trabajo y sin duda tendremos problemas si hay alguien que no la respete.

No es ilógico tampoco, planificar aquí, que los documentos estarán disponibles en determinada dirección o bien, que tendrán copias actualizadas en formato PDF. La política de propiedad de los documentos así como el responsable de centralizar la publicación de estos, son también aspectos interesantes dignos de contar con una palabra o dos.

Los planes de documentación también guardan relación con el Plan de Mejoramiento del Proceso, ya que al planificar la creación de plantillas, o la actualización de un repositorio de documentos, es posible identificar elementos reutilizables que redunden en una mejora del método de desarrollo con miras a futuros desarrollos.

Por ultimo, he de indicar, que por lo breve de su extensión, es posible que este plan lo mantengamos como parte del documento llamado Plan de Desarrollo de Software, con lo que en realidad podríamos no tener un documento por separado con esta información.

, ,

  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: