• JERARQUÍA
  • CONTENIDO
  • VACÍOS
  • HUMANO

Cómo auditar la estructura de tu documentación con IA

Conecta ReadMe con tu cliente de IA para escanear todo el árbol de documentación. Una vez conectado, tu agente podrá mapear categorías y localizar páginas específicas o enlaces rotos.

Pregunta a la IA sobre esta página

Respuesta rápida

¿Cómo puedo auditar la estructura de mi documentación con IA?

Tu IA utiliza el MCP de ReadMe para extraer listas de categorías y jerarquías de páginas. Luego, identifica vacíos, enlaces rotos o contenido obsoleto comparando la estructura real con tus requisitos. Obtendrás un mapa claro de lo que existe y lo que necesita corregirse.

Donde se centralizan los hallazgos.

Resultados de la auditoría

La IA organiza sus descubrimientos en estas áreas específicas.

JERARQUÍA

Mapa de estructura completa

La IA extrae todas las categorías y páginas personalizadas para crear un árbol visual o de texto de tu documentación.

CONTENIDO

Inventario de páginas

Enumera cada documento individual dentro de una categoría para que veas exactamente qué temas se cubren.

VACÍOS

Información faltante

La IA señala dónde existen categorías sin páginas o donde la jerarquía parece incompleta.

HUMANO

Revisión manual necesaria

La IA resalta páginas específicas que parecen obsoletas o redundantes para que las verifiques personalmente.

El flujo

Lo que hace tu IA al recibir la solicitud.

La IA recorre tu instancia de ReadMe para construir una imagen completa de tu documentación.

  1. Mapear el árbol

    El agente identifica todas las categorías principales y anidadas de tu documentación.

    list_categories

  2. Inspeccionar categorías

    Analiza el interior de categorías específicas para ver cómo están organizadas.

    get_category

  3. Localizar páginas personalizadas

    La IA encuentra cualquier página personalizada que esté fuera de la estructura estándar de categorías.

    list_custom_pages

  4. Auditar contenido de páginas

    Extrae los documentos específicos de una categoría para verificar su profundidad y relevancia.

    get_category_docs

Pruébalo

Copia estos ejemplos para empezar.

Usa estos prompts para iniciar tu auditoría.

Puntos de partida

Cambia los nombres de las categorías o los títulos de las páginas para dirigir tu auditoría.

ReadMe Connector

Todo listo. Elige tu cliente MCP y sigue las instrucciones de configuración.

Enlace del conectorhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp

Claude Desktop

Sigue los pasos siguientes para conectarte en segundos.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.
Configuración · claude_desktop_config.jsonCopiar
{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}
Copia en el chat04

  • Lista todas las categorías de mi documentación en ReadMe y muéstrame la jerarquía.

  • Revisa la categoría 'API Reference' y dime si falta alguna página.

  • Busca todas las páginas personalizadas en mi documentación y lístalas por nombre.

  • Analiza los documentos de la categoría 'Getting Started' e identifica si hay páginas redundantes.

  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Empieza aquí

Conecta ReadMe una vez y luego pregunta.

Solo tienes que vincular tu cuenta de ReadMe a Vinkius. Tus credenciales permanecen cifradas y podrás empezar a hacer preguntas sobre tu documentación en tu cliente de IA preferido.

Conectar ReadMe con tu IA

FAQ

Cómo funciona esta tarea

  • 01

    ¿Puede la IA editar mis páginas de documentación?

    No. La IA solo puede leer la estructura y el contenido. Debes realizar todas las ediciones manualmente en ReadMe.

  • 02

    ¿Puede la IA eliminar contenido obsoleto por mí?

    No. La IA identifica qué debería eliminarse, pero no tiene permisos para borrar páginas.

  • 03

    ¿Puede la IA ver mi documentación privada?

    Sí. La IA solo puede ver la documentación a la que tus credenciales de la API de ReadMe tengan acceso.

  • 04

    ¿Cómo sabe la IA si una página es obsoleta?

    La IA compara el contenido que lee con las instrucciones o patrones que tú le proporciones en tu prompt.

  • 05

    ¿Puedo auditar subcategorías específicas?

    Sí. Puedes pedirle a la IA que se concentre en una sola categoría o en un conjunto específico de páginas personalizadas.

  • ¿Más preguntas sobre ReadMe? Ver todas las funciones del conector de ReadMe

Conecta ReadMe a Claude, Cursor, ChatGPT y más