Cómo genero documentación y busco sobre ella; Excel, web, ficheros texto, Mediawiki, TiddlyWiki

19.Dec.2021 — Julio

Simpre me ha gustado registrar los nuevos conocimientos que voy adquiriendo en el trabajo y cómo he resuelto las incidencias que me han ido surgiendo.

Aparte de al escribirlas se afianzan más en mi memoria, me sirve para encontrar de forma rápida como resolver las mismas cuando al cabo de meses me vuelve a surgir y la memoria no me ayuda.

Insisto que lo más importante es poder buscar la información de forma rápida, pues no sirve de nada escribir la resolución de problemas si luego no puede localizar la solución. Por ello descarto escribir diarios o en agendas en papel.

Escribir en papel está muuy bien y mucho mejor para afianzar en memoria pero digamos que la "batería" de la memoria dura más que escribir en un documento electrónico, pero solo dura más; no es eterna. Y además ¿cómo buscas cómo se resolvió tal incidencias en una Moleskine? ¿te vuelves a releer todas las agendas de todos los años hasta encontrar el día que ocurrió?

Tengo lagunas varias de cómo registraba hace muchos años pero conservo todos los datos, otra cosa es que se puedan ejecutar los programas que hice en su dia en los ordenadores de hoy.

-- 199x

Supongo que lo primero fue el papel. Esas agendas que o bien comprabas o nos daban en los trabajos de los bancos, compañías de seguro etc.. Todo el mundo llevaba una agenda/diario encima.

1994 -

Como comentario tengo registrados todos mis entrenamientos deportivos desde 1994. Los empecé a registrar en un programa que mi hice en C. Es por eso que ...

1998 - 2000

Hice un programa en TurboC. Como en el trabajo me encargaron de toda la gestión de nóminas y seguridad social de la empresa en C, pues en aquel entonces estaba algo puesto. Ni que decir tiene que toda la gestión de ficheros era un poco .. peligrosa.

Aquí unas capturas de pantalla del programa y los datos que guardaba.

diario en C

diario2 en C

2000 - 2002

Creo que la misma filosofía del programa en C pero lo pasé a Delphi, por el sufrimiento que era el trabajar en C y encontrar que con Pascal / Delphi era la maravilla de aquellos tiempos.

2002 - 2012

Del 2002 al 2012 utilizaba un excel con unas cuantas macros. Era rápido, no muy bonito pero efectivo.

No voy a contar todo lo que se podía hacer porque me da pereza, pero se añadían registros de forma rápida y con opciones, se lanzaban otros programas, se enviaban emails desde el propio excel, se podían añadir adjuntos a las incidencias, 10 año estuve con este método y me fue muy bien.

diario en excel

2012 - 2019

Luego en 2012, cambié de idea. Quería algo que fuera más ubicuo y poder buscar información desde cualquier sitio con una conexión en internet. Página web.

https://www.julb.es/mi-todo-list-y-sobre-todo-mi-done-list..tml

diario en web

Primero montado en un equipo en casa "guruplug" en Debian, cuando no existían las raspberrys. Con Flask, python, nginx Dyndns, Go y scripts en bash para las copias de seguridad.

Podía dar de alta incidencias, poniendo el texto que quisiera, tema, marcar fecha inicio y resolución, .... y luego se podía buscar por varias palabras y sólo mostraba aquellos registros que las contuvieran pero mostrando todo el registro, no solo la línea en la que estuviera cierta palabra.

En fín. Todo basado en ficheros de texto sin bases de datos que se pudieran corromper y permitiendo así que con cualquier otro programa se pueda abrir la información al cabo de los años, sin obsolescencia técnica.

Los ficheros de texto, mi base de datos..:

diario en web

contenido de los registros:

diario en web

Estuve con guruplug varios meses, llegaron las rapberrys, lo pasé a estas y por último a un VPS con FreeBSD en DigitalOcean. Todo para evitar problemas de disponibilidad de la web o fallos en las tarjetas SD ....

Alguna vez escribiré que incluso puedo buscar MI información con Telegram.

Pero llega un momento es que te cansas de todo .. y no quieres ya tener que mantener un VPS ...

2020 unos pocos meses

Todo lo que tenía montado estaba muy bien para recoger incidencias, anotar cambios en programas y procesos..

Aparte de esto, yo me hacía mi documentación en ficheros de texto, primero en markdown y luego en asciidoctor que prefiero.

Cambié de trabajo en este año y de funciones. Tenía que aprender muchas cosas. Anotaba mucha información en ficheros de texto como siempre pero ahora necesitaba encontrar datos en ella de forma rápida.

Estuve una temporada con un script que me buscaba palabras en la documentación, osea en todos los ficheros que me iba creando. Era del tipo:

bash b () { if [[ $# -gt 0 ]]; then grep --color=auto -i "$1" /mnt/c/mydocs/documentacion/SAP/*.txt; else history; fi }

Sí, sabía de la existencia de Evernote, OneNote y demás (de hecho los utilicé para otro tipo de información) pero tengo la manía de utilizar mis herramientas y sobre todo en ficheros de texto fácilmente portables a cualquier aplicación de moda.

Esto para el tema de documentación. Seguía con la página web para el tema de incicencias.

2020 - 2021

Una de mis funciones en el trabajo era crear documentación en la Mediawiki de la empresa. Así que para aprender me monté mi propia mediawiki en mi servidor VPS.

Aproveché para pasarme toda la documentación previa al nuevo sistema. Me gustaba menos pues se requería Php, Mysql y demás, pero lo hicé y estuve utilizándola varios meses. Tengo que reconocer que la búsqueda de resultados y su muestra era mucho mejor.

Me monté una para documentación del trabajo y otra para mí personal.

documentación laboral

documentación personal

¡importante todo el tema de backup de datos en el servidor VPS y fuera de él!

2021

Pero ¿qué pasaba si el VPS se iba al carajo, me cansaba de pagarlo, de mantenerlo, o quisiera portarlo a otro sitio?

Montar otra mediawiki en FreeBSD o Ubuntu o local en casa en un rollo.

Descubrí TiddlWiki

documentación personal

Reconozco que lo descubrí gracias a Joe Armstrong

Cosas buenas:

se utiliza un navegador, cualquiera
no hace falta tener un servidor
se puede utilizar en un único fichero .html que te puedes llevar cuando quieras al sitio que quieras
la búsqueda es muy rápida
el sistema de meter notas es mejor utilizando sistema https://es.wikipedia.org/wiki/Zettelkasten que se basa en todo notas breves pero relacionadas.
fácil de montar un To_Do list
configurable aunque no de forma tan fácil.
fácil exportar a texto o csv o json
permite encriptación del html entero o solo de las notas que se considere.
te puedes crear tantas wikis como quieras, cada uno un fichero ..

Cosas malas:

las imágenes es mejor "enlazarlas" que embeberlas pues se puede convertir en un html gigante.
la configuración de personalizaciones es algo compleja.
la información está todo dentro de un html que no es tan visual si se abre con otra aplicación que no sea un navegador.
si quieres disponer de tu información de la wiki por internet no es tan fácil. Se necesitan complementos pero lo más sencillo es ponerla en Google Drive o Dropbox. (se puede encriptar de forma que esté más segura tu información privada)

documentación personal