Usar la documentación con un asistente
El sitio publica su contenido en dos archivos de texto plano, pensados para dárselos a un asistente como material de referencia.
| Archivo | Peso | Para qué |
|---|---|---|
| llms-full.txt | 677 KB, unos 170.000 tokens | La documentación completa, con la URL de cada página |
| llms.txt | 6 KB | Sólo el índice: título, descripción y URL de cada página |
Los dos se generan en cada publicación, así que están siempre al día. El primero incluye la referencia completa del schema, que es el 80 % de su tamaño: los 116 elementos y 444 atributos con su descripción.
Claude de escritorio y claude.ai
Sección titulada «Claude de escritorio y claude.ai»Conviene cargarlo una vez como conocimiento de un proyecto, en lugar de adjuntarlo en cada conversación:
-
Crear un proyecto (Projects → New project).
-
Descargar
llms-full.txty subirlo al conocimiento del proyecto. -
En las instrucciones del proyecto, escribir algo así:
Las respuestas sobre Histrix se basan en el archivo de documentación del proyecto. Al citar un atributo o un tag, incluir la URL de la página de donde sale. Si el archivo no dice algo, decir que no está documentado en lugar de inferirlo del nombre.
A partir de ahí, cada conversación del proyecto busca en el archivo sin gastar contexto en cargarlo entero.
Cuando se publique una versión nueva de la documentación hay que volver a subir el archivo: el conocimiento del proyecto es una copia, no un enlace.
Claude Code
Sección titulada «Claude Code»La forma que menos contexto gasta es dejar el archivo en el repositorio y decirle cuándo consultarlo. Desde la raíz del proyecto:
curl -o docs/histrix-docs.txt https://docs.histrix.com.ar/llms-full.txtY en el CLAUDE.md del repositorio:
## Referencia de Histrix
`docs/histrix-docs.txt` tiene la documentación completa del framework: los 116 tags y444 atributos del schema, la API REST y la operación.
Antes de usar un tag o atributo del que no estés seguro, buscalo ahí:
grep -n "nombreDelAtributo" docs/histrix-docs.txt
Si no aparece, el motor no lo lee: no lo escribas. Las descripciones dicen lo que elmotor hace, que muchas veces no es lo que el nombre sugiere.Para actualizarlo, el mismo curl. Si el archivo se versiona en el repositorio, el
diff muestra además qué cambió en la documentación.
Consulta puntual, sin instalar nada
Sección titulada «Consulta puntual, sin instalar nada»Sirve para una pregunta suelta, en cualquier asistente con acceso a internet:
Leé https://docs.histrix.com.ar/llms.txt y después la página que correspondapara responder: ¿qué hace exactamente esClave="false"?El índice pesa 6 KB, así que el asistente puede leerlo entero y decidir qué página pedir. Para el ejemplo de arriba iría a la referencia de campos.
Qué pedirle
Sección titulada «Qué pedirle»Las descripciones del schema están verificadas contra el código del motor, así que hay tres preguntas que este material responde bien y que de otro modo se contestan adivinando:
- ¿Este atributo existe? Si no está en la lista de atributos, el motor no lo lee. La documentación anterior a esta describía una veintena que no hacían nada.
- ¿Qué hace exactamente
="false"? No hay una respuesta única: el motor evalúa los booleanos con cuatro criterios distintos, y en varios atributos escribirfalseactiva la función. - ¿Dónde va este tag? El índice de elementos dice qué admite cada elemento, con la cantidad de veces que puede aparecer.
Conviene pedirle que cite la URL de donde saca cada afirmación: es lo que permite verificarla en un clic.