martes, 4 de diciembre de 2012

Documentando de manera inteligente: OSQA


Muchos conocen los sitios de QA (Question & Answer, Preguntas y Respuestas) como:

http://stackoverflow.com/
http://serverfault.com/
http://askubuntu.com/
http://www.commandlinefu.com/commands/browse
http://unix.stackexchange.com/

etc.

Pero no tantos saben que es muy fácil montar un sitio propio y customizarlo. Lo pueden hacer con OSQA

http://www.osqa.net/

OSQA permite hacer preguntas y contestarlas, subir archivos, añadir links, etc., prácticamente las mismas capacidades que pueden encontrar en otros sitios de QA como los mencionados al principio.


Instalar OSQA
OSQA corre sobre Windows, Linux y cualquier OS que corra Postgresql, Python (Django), y Apache (muy probablemente funcionará bien con cualquier webserver).

Lo pueden instalar de modo muy sencillo vía:

http://bitnami.org/stack/osqa

(Windows, Linux, Vmware images, Amazon images, etc.)

Este package tiene autocontenidos todos los requerimientos de OSQA (Apache, Postgresql y Django), y un instalador muy bueno lo configura automáticamente todo en un par de pasos (tiene un modo gráfico y un modo texto, el instalador detecta cual puede usar y ofrece las mismas opciones en ambos). Si chequean el directorio de instalación van a ver que lo pueden pasar a español fácilmente, y además customizar bastante bien (logo a mostrar, fav icon a mostrar, título, mails y URLs administrativas, etc.).

* El único issue es que al estar OSQA totalmente autocontenido, los updates de seguridad de los paquetes del sistema (o software si fuera que lo están corriendo en Windows), no van a actualizar el software dentro del directorio de OSQA.

* La ventaja es que el directorio es 100% portable entre instalaciones, con mínimos cuidados. Simplemente se baja OSQA (incluye un script de control centralizado), y luego de lo puede copiar a cualquier otro server.

# La configuración manual tampoco parece demasiado difícil, de todos modos, si no encuentran un tutorial convincente, simplemente pueden dumpear la DB creada por el instalador Bitnami, volcarla en una DB en el Postgresql del sistema, y luego copiar los files de configuración del OSQA  configurado con el instalador de Bitnami, a donde tengan deployado el OSQA "a pelo".


Documentando con OSQA
Un uso práctico de OSQA es para documentación interna de un área de sistemas, donde los usuarios van a ser los miembros del equipo IT / área informática / depto. informática, etc.

La clave está en saber seleccionar las etiquetas que se va a usar para ir cargando el site con preguntas y respuestas útiles, así más tarde se puede buscar fácil e intuitivamente una información antes cargada.

Es muy interesante el que cuando alguien haga una pregunta, las diferentes respuestas tendrán un origen determinado en un usuario puntual, y los diferentes usuarios (recordemos, miembros del equipo IT), podrán plantear inclusive soluciones diferentes para el mismo problema (idealmente proveyendo links y documentos accesorios útiles).


La documentación formal se puede cargar igualmente, inclusive solamente con título y subiendo los  archivos en el formato de origen (pdf, doc, xls, txt, jpg, png, etc.). En este caso por ejemplo, la documentación oficial debería ser la única a la que pudiera asignarse la etiqueta "documentacion".

Se puede y se debería añadir varias etiquetas a cada pregunta/respuesta, de modo de facilitar su localización posterior.

Este método de organización de documentación permite un uso potencialmente mucho más efectivo de la información guardada por el equipo IT, que
- el clásico y simple método de guardar documentación en un directorio compartido (clasificado todo por categorías/carpetas),
- utilizando una wiki

OSQA permite implementar una metodología de documentación muy interesante para reemplazar rápidamente a un CMS (Content Management System), como Alfresco o Sharepoint, que muchas veces simplemente terminan siendo pequeñas junglas de portales por área/tema/proyecto, carpetas y subcarpetas de contenido sin ningun orden, mucha veces repetido (porque los usuarios encuentran un documento y lo copian a sus propias carpetas para no perderlos si el autor los edita/borra/mueve de carpeta en algun reordenamiento), y con pocas chances de localizar el contenido rápidamente.

El problema principal con los CMS no son sus capacidades (al contrario, tienen muchas y muy útiles), sino que requieren supervisión constante para evitar la replicación de contenido y la excesiva complejidad en su estructura (con muchos subdirectorios anidados por ejemplo). Un software de QA provee todos los puntos de vista y la información relevante - la de cada usuario que accede y responde a una pregunta - en un solo punto focalizado (lo que permite contrastar puntos de vista opuestos y valorar comparativamente diferentes soluciones y respuestas propuestas), y las etiquetas se encargan de facilitar la rápida localización de la información buscada.

2 comentarios:

Fercol dijo...

Me podrias ayudar a instalarlo en algun hosting? un saludo

Lesbian Girls dijo...

your article is nice here tutorial is this