|
Un Wiki para la documentación del proyecto |
|
|
09.04.2006 |
 Gestionar la documentación de un proyecto con un wiki es una opción digna de tenerse en cuenta.
Tanto para los requisitos, o historias de usuario (según los casos) como para los documentos de arquitectura, las plataformas wiki ofrecen ventajas interesantes sobre la frecuente combinación de documentos word más una herramienta de gestión de la configuración (Ej: CVS).
La implantación de un wiki implica la asignación de responsabilidades para su uso, pero en muchas organizaciones, las ventajas pueden compensar sobradamente a los inconvenientes.
Los principales beneficios son:
- La unidad de documentación es la página, y no el documento, facilitando la edición concurrente e independiente.
- La documentación es accesible desde cualquier ordenador con un navegador.
- La capacidad de transclusión de los wikis permite incluir la misma información en diferentes partes sin crear redundancia.
- Coste muy reducido. Todo el sistema puede abordarse con soluciones de uso gratuito: Apache - PHP - MySQL - Plataforma Wiki (ver referencias al final del artículo).
Durante el curso pasado, un grupo de alumnos del Master de Ingeniería del Software de la Universidad Carnegie Mellon llevaron a cabo dos experimentos de implantación real de una plataforma wiki para la gestión de los documentos de arquitectura de dos proyectos de software.
El informe técnico de SEI "Experience Using the Web-Based Tool Wiki for Architecture Documentation" describe la experiencia y sintetiza los resultados. En él se incluye una tabla comparativa entre un entorno con Word + CVS y un Wiki.
Se echa de menos que en el informe no indiquen qué plataforma Wiki emplearon, aunque por las imágenes del apéndice creo que fue MediaWiki (la misma que Wikipedia)
Tabla comparativa
| Funcionalidad |
Word + CVS |
Wiki |
| Edición concurrente y tamaño de la unidad de edición y consulta |
|
|
| No redundancia de la información común |
|
|
| Trabajo sin conexión |
|
|
| Configuración simple en el cliente |
|
|
| Plantillas para los documentos |
|
|
| Capacidad de búsqueda |
|
|
| Navegación y tabla de contenido |
|
|
| Revisión |
|
|
| Histórico de cambios |
|
|
| Notificación de cambios |
|
|
| Formato de texto |
|
|
| Edición WYSIWYG |
|
|
| Impresión de documentos |
|
|
| Control de acceso |
|
|
| Entrega de documentación |
|
|
Más información:
- Listado y descripción de plataformas Wiki.
- Informe "Experience Using the Web-Based Tool Wiki for Architecture Documentation".
Tags:
gestión de la configuración,
gestión de proyectos,
documentación,
wiki.
|
Suscripción
RSS 
