La documentación técnica es una de esas tareas que rara vez fracasan ruidosamente en los proyectos, pero que con frecuencia quedan relegadas en silencio. Una nueva herramienta llamada Blume aborda precisamente este punto: basta un único archivo Markdown para generar a partir de él una documentación completa en la web, incluida navegación, función de búsqueda y una conexión mediante MCP.

Qué ofrece la herramienta según su anuncio

El enfoque es deliberadamente esbelto. El punto de partida es Markdown, es decir, un lenguaje de marcado de texto sencillo en el que los encabezados, las listas y los ejemplos de código se estructuran con unos pocos caracteres especiales. A partir de este archivo fuente, Blume genera una documentación HTML que puede abrirse en el navegador.

Dos componentes convierten la mera conversión de texto en un portal utilizable: una navegación que se deriva de la estructura del documento y una búsqueda con la que los lectores pueden localizar pasajes concretos. Así se elimina aquel esfuerzo que a menudo supone el inicio de los proyectos de documentación: montar el árbol de páginas, construir plantillas, configurar el índice de búsqueda.

La conexión MCP como verdadera diferencia

Llama la atención el segundo canal de salida. Blume pone además la documentación a disposición a través de MCP. MCP son las siglas de Model Context Protocol, una convención de interfaz mediante la cual los asistentes de IA pueden consultar contenidos y herramientas externos sin que haya que programar una integración propia para cada sistema.

En la práctica, esto significa que la documentación no es solo un sitio web para personas, sino al mismo tiempo una fuente consultable para sistemas de asistencia. Quien trabaja en un entorno de desarrollo o en un asistente de chat puede consultar allí los contenidos de la documentación, en lugar de buscarlos en una segunda ventana y transferirlos mediante copiar y pegar.

Este doble uso es el punto clave. Hasta ahora, los portales de documentación y los flujos de trabajo con IA eran mundos separados: por un lado, un generador de sitios estáticos; por otro, contenidos que había que trasladar trabajosamente a un índice o a una base de datos vectorial para que un asistente pudiera trabajar con ellos. Cuando la propia documentación actúa como fuente MCP, este paso intermedio desaparece.

Por qué un único archivo es un argumento

A primera vista, mantener una documentación en un solo archivo suena a limitación. En muchos proyectos de medianas empresas ocurre lo contrario. Un único documento de texto se puede versionar, revisar en el pull request y editar sin sistema de gestión editorial. No hay convenciones de carpetas que haya que conocer ni archivos de configuración que nadie entienda ya después de medio año.

Igual de importante: baja el umbral de entrada para las contribuciones. Quien quiera documentar un mensaje de error o añadir un paso de despliegue abre un archivo y escribe dos párrafos. Según la experiencia, es precisamente este pequeño obstáculo el que decide si una documentación se mantiene actualizada o queda obsoleta tras la finalización del proyecto.

Los límites del enfoque son evidentes y deben evaluarse de forma realista. Un archivo sigue siendo manejable mientras el volumen sea manejable. Para documentaciones de producto extensas con varias versiones de idioma, públicos objetivo y procesos de aprobación, un sistema de gestión editorial estructurado sigue siendo la opción más adecuada.

Campos de aplicación típicos en el día a día del proyecto

Para qué casos se presta un enfoque tan esbelto puede delimitarse bien:

  • Documentación técnica de proyecto: decisiones de arquitectura, guías de configuración e indicaciones de operación que viven en el repositorio junto al código.
  • Manuales internos: procedimientos, responsabilidades y listas de verificación para un equipo, que no necesitan un sitio web corporativo pero sí deben ser consultables.
  • Documentación de interfaces e integraciones: descripciones que los desarrolladores necesitan de todos modos durante el trabajo en el editor; aquí la conexión MCP resulta especialmente valiosa.
  • Traspasos: todo lo que al final del proyecto pasa al cliente o a un equipo interno y debe seguir manteniéndose allí sin conocimientos especializados.

Qué hay que aclarar antes de la implantación

Quien pruebe una herramienta así debería responder de antemano a algunas cuestiones organizativas. ¿Dónde está el archivo fuente y quién puede modificarlo? ¿La salida HTML se regenera automáticamente con cada cambio o es un paso manual que en algún momento nadie vuelve a ejecutar?

En la conexión MCP se añade la cuestión del acceso. La documentación interna contiene a menudo datos que no pertenecen a un asistente de acceso público: direcciones de servidor, detalles de procesos, nombres de personas de contacto. Merece la pena, por tanto, separar desde el principio lo que se documenta públicamente de lo que permanece interno.

Clasificación

Blume no es un nuevo paradigma, sino una indicación de hacia dónde se mueven las herramientas de documentación: lejos de portales costosos, hacia contenidos que sean a la vez legibles para las personas y consultables para los sistemas de asistencia. Para los proyectos web y de software, esto significa considerar MCP en el futuro como un canal de salida habitual, igual que hoy el HTML y el índice de búsqueda. Quien ya mantiene la documentación como archivo de texto en el repositorio puede complementar este segundo canal con poco esfuerzo y ahorrarse más adelante la reestructuración de paisajes de documentación que han ido creciendo.

Fuentes