Documentación

Requisitos

Ollama con al menos el modelo qwen2.5-coder:3b (ver Descargas). Funciona con 8 GB de RAM; con una tarjeta gráfica las respuestas llegan en pocos segundos, y en CPU tardan más.

Guía de uso

1. Preguntar

Escribe tu pregunta y pulsa Buscar (o Enter; Shift+Enter para un salto de línea). Debajo de la respuesta aparecen las fuentes consultadas, numeradas.

El selector Documentación decide dónde buscar: automática detecta la tecnología por tu pregunta, Sin documentación responde solo con el modelo, y también puedes fijar una tecnología concreta.

2. Analizar código

Pega el código entre ``` seguido de tu pregunta. La app busca la documentación de las APIs que usa y responde con qué hace, qué falla y una versión corregida. Con el código pegado, los botones Optimizar, Explicar, Corregir errores y Generar tests lanzan esa petición directamente.

3. Documentación offline

En ⚙️ Configuración → Documentación offline, pulsa Descargar en las tecnologías que uses. Cada paquete se descarga, se indexa y, si tienes nomic-embed-text, se prepara la búsqueda semántica. Si instalas ese modelo más tarde, el botón Activar semántica la añade a los paquetes que ya tenías. Cuando haya una versión nueva de la documentación aparecerá Actualizar.

4. Cambiar de modelo

En Configuración puedes elegir otro modelo de chat. Si no está descargado, la app se lo pide a Ollama.

Cómo se busca la documentación

Para cada pregunta, el modelo genera primero unos términos de búsqueda en inglés. Después, si la tecnología está descargada, la app busca en su índice local combinando búsqueda por texto (BM25) y, si está activada, búsqueda semántica. Si no está descargada, consulta la web oficial. Los dos documentos más relevantes se pasan al modelo junto a tu pregunta.

Medido con qwen2.5-coder:3b en una NVIDIA RTX 4060. En CPU los tiempos del modelo son mayores.

Privacidad y datos

La IA corre en tu equipo: ni tus preguntas ni tu código se envían a ningún servicio de IA. Las conversaciones y la documentación descargada se guardan en una base de datos local (%APPDATA%\snippet-bot-assistant\assistant.db en Windows).

Solo hay conexiones a internet para descargar paquetes de documentación y, cuando una tecnología no está descargada, para consultar su web oficial. En ese caso, lo único que se envía son los términos de búsqueda que genera el modelo (unas pocas palabras, como Promise.all), nunca tu pregunta ni tu código. Si eliges Sin documentación o la tecnología está descargada, la consulta no sale de tu equipo.

Problemas frecuentes

Arquitectura

main.js            # proceso principal: IPC con la interfaz
preload.js         # puente seguro (contextIsolation activo)
renderer.js        # interfaz: chat, historial y paquetes de documentación
src/
├── ai-engine.js     # Ollama: chat, términos de búsqueda y embeddings
├── scraper.js       # detección de tecnología y búsqueda (local y web)
├── docs-index.js    # paquetes DevDocs, índice FTS5, vectores y búsqueda híbrida
├── docs-sources.js  # fuentes de documentación por tecnología
├── database.js      # SQLite: conversaciones, mensajes y caché
└── markdown.js      # conversión de HTML a Markdown

Construida con Electron, SQLite (con búsqueda de texto completo FTS5) y Ollama. Sin frameworks de interfaz: HTML, CSS y JavaScript.

Roadmap

• Próximo Respuestas en streaming, exportar conversaciones a Markdown
• Después Recomendar un modelo mayor según la tarjeta gráfica, guías conceptuales además de la referencia
• Idea Extensión de VS Code que use el mismo motor local

Contribuir

Los issues y pull requests son bienvenidos. Abre un issue describiendo el problema (con pasos, sistema operativo, modelo de Ollama y una captura) o la funcionalidad que echas de menos.