Etiquetas: Producto

Documentación que también lee una máquina

Cada página se sirve como texto plano y el sitio publica un índice. Por qué escribir para agentes mejoró la documentación para las personas.

Sofía Ibarra · · 1 min de lectura

Cuando empezamos a pensar en cómo un agente lee nuestra documentación, nos dimos cuenta de que muchas páginas fallaban también para las personas: títulos vagos, ejemplos incompletos, reglas escondidas.

Cada página, también como texto

Toda página tiene una versión en texto plano con la misma estructura. No es un extra: es la prueba de que el contenido se entiende sin el diseño alrededor.

Un índice en la raíz

Un archivo en la raíz lista todas las páginas con una línea de descripción. Sirve para un agente y sirve para quien llega sin saber qué buscar.

Para seguir leyendo