llms-txt-generator
Genera documentación estructurada y optimizada para LLMs siguiendo el estándar llms.txt.
Triggers
| Frases que activan el skill |
|---|
| “crear llms.txt” |
| “documentar para AI” |
| “crear documentación para LLMs” |
| “generar docs para modelos” |
| “hacer repo legible para Claude” |
¿Qué genera?
llm-docs/
├── llm.txt # Main index (~1-2 KB)
├── llm.version.txt # Metadata y sync info (~0.3 KB)
└── llm.{domain}.txt # Archivos por dominio (~3-50 KB c/u)
Workflow
1. Selección de idioma
¿En qué idioma preferís la documentación?
- Español
- English
- Bilingual (términos técnicos en inglés, explicaciones en español)
2. Análisis del proyecto
| Indicador | Tipo de proyecto |
|---|---|
components/, design tokens, SCSS | Frontend/UI Library |
cmd/, CLI flags, subcommands | CLI Tool |
/api/, OpenAPI, routes | REST/GraphQL API |
src/, exports, package.json | Generic Library |
3. Planificación de dominios
Frontend/UI:
- tokens, utilities, styles, brands
- components-atoms, components-molecules, components-organisms
CLI Tools:
- commands, core, gateway, deployment, resources, testing, usage
APIs:
- endpoints, models, auth, errors, examples
Libraries:
- api, internals, patterns, examples
4. Decisión de implementación
| Condición | Approach |
|---|---|
| Datos estructurados (JSON, JSDoc, OpenAPI) | Script generador |
| Documentación manual | Archivos estáticos |
| Fuentes mixtas | Híbrido |
Estructura de archivos
llm.version.txt
# {Project} LLM Documentation
- **Version**: 1.0.0
- **Last Updated**: 2025-12-25
- **Documentation Version**: 1.0.0
- **Files**: 5 domain files
- **Total Size**: ~25 KB
llm.txt (index)
# {Project} - LLM Documentation
## Project Metadata
- **Name**: my-project
- **Type**: frontend
- **Language**: TypeScript
- **Purpose**: UI component library
## Documentation Structure
### Components
#### llm.components.txt
- **Focus**: All UI components
- **Use when**: Working with UI elements
### Tokens
#### llm.tokens.txt
- **Focus**: Design tokens and theming
- **Use when**: Styling or theming
llm.{domain}.txt
# Components - My Project
## Overview
UI components for the design system.
## Button
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| variant | 'primary' \| 'secondary' | 'primary' | Visual style |
| size | 'sm' \| 'md' \| 'lg' | 'md' | Button size |
## Related Files
- `llm.tokens.txt` - For styling customization
Best practices
- File size: Mantener cada archivo bajo 50 KB
- Cross-references: Links claros entre archivos
- Tables: Usar markdown tables para propiedades
- Code examples: Incluir ejemplos copy-pasteable
- Hierarchy: H1 para título, H2 para secciones, H3 para subsecciones
Script generador
Si el proyecto tiene datos estructurados, el skill puede crear un script:
// build-scripts/create-llms-docs.js
const config = { COMPONENTS_DIR, OUTPUT_DIR };
// Extractors
function extractComponents() { ... }
function extractTokens() { ... }
// Generators
function generateIndex() { ... }
function generateVersion() { ... }
function generateDomain() { ... }
function main() {
// Extract all data
// Generate all files
// Log summary
}
{
"scripts": {
"generate:llms": "node build-scripts/create-llms-docs.js"
}
}
Uso del output
Una vez generados, los archivos pueden ser:
- Incluidos en prompts de AI:
@llm-docs/llm.commands.txt How do I deploy to staging? - Referenciados en CLAUDE.md:
## LLM Documentation Ver `llm-docs/` para documentación optimizada para AI. - Mantenidos automáticamente:
npm run generate:llms # Regenerar después de cambios
Herramientas disponibles
- Todas las herramientas estándar para análisis y escritura