Inicio arrow Herramientas arrow Gestión de proyectos arrow Un Wiki para la documentación del proyecto Make Text BiggerMake Text SmallerReset Text Size

Navegápolis publica actualmente en navegápolis.com.

Ir a navegapolis.com

Un Wiki para la documentación del proyecto
Valoración del artículo: / 16
MaloBueno 
09.04.2006
WikiGestionar 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:


Tags: gestión de la configuración, gestión de proyectos, documentación, wiki.
Trackback(0)
Comentarios (3)Add Comment
Yo lo hice
escrito por Invitado, April 10, 2006
Hace un tiempo implante un wiki en la empresa donde trabajo, en la cual existia cero documentacion de los proyectos,
y no era la politica del depto de desarrollo documentar. Entonces puse FlexWiki que esta desarrollado en .net, ya que tenia la limitacion de usar unicamente tecnologia MS. Entonces cada ves que alguien me consultaba algo, e investigaba en el codigo, lo volcaba al wiki y le decia que lo buscara en wiki. Asi poco a poco mis compaeros y mi jefe se fueron acostumbrando.
Creo que es una buena alternativa y rapida a usar word compartido y gestionado por cvs.
Esa es mi experiencia.
Otra alternativa (sin interactividad), L
escrito por Invitado, April 10, 2006
Si es necesario escribir el informe para imprimirlo y además se quiere publicar en HTML sin posibilidad de editarla ni interactividad con el usuario, puede resultar más sencillo escribirla en LaTeX, un potentísimo editor de textos que es muy utilizado en la comunidad universitaria y científica.

Aunque no es un procesador de textos del tipo WYSYNG, con unos pocos comandos que se aprenda, se obtiene un resultado final a años luz de Word y otros procesadores de textos. Una vez compuesto el documento mediante LaTeX, éste puede exportarse a PDF, PS, DVI de forma autómatica y rápida y su posterior conversión a HTML es instántanea sin que el consultor se preocupe por los enlaces, el índice, la paginación o aprender lenguaje hipertexto. Click y voalá.

Yo siempre dejo en los servidores de los clientes: el informe final en formato HTML (generado con latex2html) y enlaces al mismo en dos formatos (PDF y Poscript que son generados a partir de la fuente latex). La fuente, el fichero latex queda en casa siempre.

+info:
LaTeX
LaTeX2htm
CervanTex
Grupo español de LaTex
Un saludo,
E Garrido
dokuwiki
escrito por yo, May 05, 2008
Un buen wiki sencillo es el dokuwiki. No requiere base de datos, por lo que es tan sencillo de instalar como copiarlo sobre una carpeta de un servidor web con php. (Y las copias de seguridad obviamente son de lo más sencillas).
Proporciona buena funcionalidad, y tiene control de acceso bastante completo por usuario y password, (arriba pones que los wiki no tienen control de acceso).
Para mi es de lo mejor, especialmente porque lo tienes todo clasificado por "namespaces" (como carpetas) y enlazado, y puedes hacer busquedas muy rápidas.
Lo dificil es poner a la gente de acuerdo en que hay que olvidarse de documentar rellenando documentos de word, que al final son lentos de leer y de buscar informacion en ellos.

un saludo.

Escribir comentario

busy
 
< Anterior   Siguiente >
Advertisement





Artículos relacionados

Registrado en Safe Creative