El Sistema de Documentación

Pregunta publicada en foros (por cierto sin que encontrara una buena respuesta) y hecho justo antes de decidir utilizar WordPress como herramienta de documentación.

El Sistema de Documentación definitivo, ¿existe?

Hola, este va a ser un post un poco largo (mis disculpas) pero creo que el tema lo merece.

Me gustaría saber vuestra opinión sobre cual es el sistema en el que documentar nuestros conocimientos de informática, programación, manuales, etc.

Os voy a contar mi experiencia y creo que sería muy interesante saber si existe alguna solución definitiva que destaque sobre las demás.

Me dedico a programar principalmente en PHP, VB y Access lo cual también me obliga a tener nociones de MySQL, HTML, Java, un poquito de Flash, Photoshop, GIMP, Zend, etc etc etc (¿os suena verdad?). Esta variedad de entornos exige una herramienta genérica y no un documentador de código específico.

Como ya os habréis encontrado muchas veces hay muchas ocasiones en las que te enfrentas con un problema, lo solucionas y te gustaría documentarlo para que dentro de unos meses o años puedas recuperar la solución. ¿Cómo hacerlo?

En otras ocasiones la documentación se trata de generar un manual para el usuario que se pueda ir reutilizando en posteriores instalaciones y clientes.

Otra necesidad suele ser documentar ideas y proyectos que se me ocurren, cosas interesantes que leo en alguna revista de informática y temas en general que quiero dejar par más adelante.

Y finalmente si se tiene alguna afición como pueda ser hacer alguna receta de vez en cuando poderlo guardar también.

Lo ideal sería tener todo esto en un solo sitio y poder encontrar la información lo más rápido posible, ahora os comento las distintas soluciones que he ido utilizando pero que ninguna me acaba de satisfacer al 100%

Word + Google Desktop

Primero empecé con una carpeta y un documento Word por tema, utilizando Google Desktop para buscar después la información, no es mala solución, es práctica pero tiene dos inconvenientes: no la puedes colgar en Internet para acceder desde cualquier sitio y no se puede implantar un buen sistema de navegación de categorías.

HTML + Google Desktop

Un poco mejor que el anterior, se puede colgar en Internet pero sigue el problema de la navegación por categorías.

HTML WorkShop o RoboHelp

Herramientas interesantes, pero de pago. Quizás sea lo que más se acerca a lo que busco pero aún no he profundizado suficiente en ellas

WikiPedia

Casi lo mejor que he probado, pero se me hace un poco pesado que no sea HTML estándar y que todos los árboles de categorías me los tenga que crear a mano. ¿Existe algún generador de navegación por categorías?, sería la bomba para mí. Por cierto, ¿alguien sabe si el TWiki sería más adecuado para esta documentación integral?

Mantis y Similares

Muy bien para documentar incidencias pero no enfocado a la documentación, manuales, etc.

DocBook

Aún no me he enterado muy bien de lo que es pero no creo que sea una herramienta de documentación si no más bien un protocolo de desarrollo de documentos.

Desarrollo Propio

Una pequeña aplicación en PHP que me permite documentar en HTML de forma caótica, definiendo las categorías/subcategorías y Tags usando las etiquetas META pero tengo pendiente el tema de hipervínculos entre páginas y mejorar la gestión de imágenes. Inconveniente: Mucho trabajo.

Doxygen

Lo acabo de descubrir, pero, ¿es solo para documentar software?

Bien, esto de momento espero que podáis aportar vuestras experiencia y poder llegar a utilizar un sistema que me permita unificar toda mi información, documentación manuales, ideas, etc.

Un saludo a todos y perdón por este post tan largo.

Tags:

About Alex Borrás

Informático, especializado en desarrollo Web con WordPress, Redes Sociales y posicionamiento en buscadores (SEO). Fan de la OOP y como afición jugador de Ajedrez. Geek por vocación & iphonero.

Subscribe

Subscribe to our e-mail newsletter to receive updates.

?????????