Vista general de referencia

Vista general

Referencia es el hogar para documentación compacta y orientada a reglas que no pertenece dentro de un artículo paso a paso. Úsala para hechos duraderos, restricciones, terminología y resúmenes de comportamiento de producto que usuarios o equipos de soporte necesiten consultar rápido.

Esta sección no debe convertirse en un segundo sistema de guías. Guías permanece separado de Docs. Referencia debe apoyar la documentación de producto haciendo que los hechos importantes sean fáciles de recuperar.

Qué pertenece a Referencia

Buenos temas de referencia incluyen:

• Matrices de comportamiento de flujos de trabajo.
• Resúmenes de planes, uso o límites.
• Reglas de agenda en calendario.
• Reglas de pedidos y verificación de pagos.
• Terminología tipo glosario cuando sea específica de la documentación de Interlinked.
• Referencias de API o webhooks si esas superficies se documentan más adelante.

Las páginas de referencia deben ser factuales, fáciles de escanear y estables. Si un tema enseña a completar una tarea, probablemente pertenece a una sección de producto en lugar de Referencia.

Cómo Referencia ayuda a recuperación por LLM

Las páginas de Referencia son útiles para búsqueda y exportaciones LLM porque concentran reglas exactas en un solo lugar. Por ejemplo, los hechos en Calendario - notas y comportamientos importantes son más fáciles de recuperar cuando usuarios o LLMs necesitan un resumen breve de reglas de agenda.

Al agregar nuevas páginas de Referencia, usa títulos explícitos y evita nombres vagos como “Notas” o “Varios”. Prefiere títulos que indiquen el área de producto y el tipo de regla.

Guía de mantenimiento

Las páginas de Referencia deben revisarse cuando cambie el comportamiento del producto. Suelen resumir reglas de las que dependen otros artículos, así que una referencia incorrecta puede generar confusión en toda la documentación.

Documentación relacionada

Usa esta página junto con Vista general de flujos de trabajo, Calendario - notas y comportamientos importantes y Verificación de pagos y seguridad.