Documentación, documentación…

La documentación de las bases de datos suele ser una labor tediosa, incómoda, antipática que supone una gran cantidad de trabajo y esfuerzo y que suele llevar demasiado tiempo. Ahí precisamente es donde estaba yo: se me pide que documente -tampoco de forma excesivamente detallada, ya que es para usuarios finales- las mil y pico tablas de nuestro DW. Las opciones son básicamente dos: utilizar las herramientas de modelado (ERwin, Powerdesigner) y sus generadores de informes que producen verdaderos ‘ladrillos’ y son difíciles de modificar, o generar documentación a partir del contenido (metadatos, diccionario de datos) de la propia base de datos mediante ‘queries’ y word…

Así que buscando alternativas me encontré con una utilidad llamada Elsasoft SqlSpec. Bajé la versión de evaluación para probar y jugar un poco y la verdad es que me parece una pequeña maravilla. En 35 segundos (¡!) me generó la documentación de una base de datos Teradata de 100 tablas. Dicha documentadión se crea en HTML, de forma que se puede publicar utilizando cualquier ‘webserver’ (como una mini-versión de Teradata Meta Data Services), pero es que, además, genera la misma documentación en un fichero con formato chm (Microsoft Compiled HTML Help) con sus funciones de búsqueda, navegación, etc…

En general, la herramienta es un poco ‘pedestre’, pero también es bastante configurable mediante opciones en un fichero de proyecto (.ssproj) que no es otra cosa que XML (vamos, que alguien con perfil ‘técnico’ le sacará mucho más provecho). Como ejemplo: puedes fácilmente cambiar las cabeceras y pies de las páginas HTML para que muestren el nombre o logo que prefieras.

Por el lado del ‘debe’, la documentación es escueta y deja bastante que desear. También está el hecho de que casi todos los literales de la documentación generada están en inglés, sin que haya encontrado hasta el momento una forma sencilla de cambiarlo.

Pero la herramienta en sí está muy bien. Es barata (unos 118 €) y en pocos minutos puedes tener una documentación bastante digna de las bases de datos a partir de su propia información. Funciona con bases de datos Microsoft SQL Server 2000/2005/2008, Microsoft Analysis Server 2005/2008, Microsoft Report Server 2005/2008, Microsoft Integration Server 2005/2008, Microsoft Access, MySQL, Teradata (la documentación dice desde la versión 13, pero yo lo he probado con Teradata V.12 sin mayor problema), Oracle, DB2, PostgreSQL, Sybase ASE, Sybase SQL Anywhere, Informix, SQLite, VistaDB, Polyhedra y Raima RDM Server.

Y desde luego, es ideal para esas ocasiones -nos ha pasado a todos- en las que ‘heredas’ una base de datos sin apenas documentación y te las tienes que ingeniar rápidamente para intentar comprender la estructura.

Saludos.

Carlos.

Anuncios

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: