CommunityRedacción y edicióngithub.com

Planificador de Documentación

Identifica brechas en la documentación y prioriza el backlog de documentos. Útil al planificar un sprint de mejora de documentación, después de señales de fricción repetida, cuando se lanzan nuevas funciones del SDK sin documentación, o para evaluaciones periódicas de salud.

¿Qué es Planificador de Documentación?

El Planificador de Documentación es una habilidad para agentes de IA que analiza la documentación técnica existente y produce un backlog priorizado de brechas. Primero, examina la estructura de navegación y los archivos de contenido en la documentación actual para categorizarlos por tipo (tutorial, guía práctica, referencia, explicación) y área de cobertura (inicio rápido, herramientas, agentes, multiagente, despliegue, etc.). Luego, identifica brechas comparando con la superficie del SDK, los principios de Diataxis (todos los tipos de contenido para cada área funcional), señales de la comunidad (como issues de GitHub etiquetados con 'documentation') y documentación de competidores (LangChain, CrewAI, Anthropic, OpenAI) si se proporciona. Finalmente, prioriza cada brecha en una escala de P0 (crítica) a P3 (backlog) según el impacto en el desarrollador y el esfuerzo requerido, y genera un informe en markdown con una matriz de cobertura y recomendaciones accionables. Esta habilidad es ideal para equipos de documentación que buscan mejorar sistemáticamente su documentación técnica sin escribir el contenido real.

Compatible con✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/strands-agents/harness-sdk/tree/HEAD/.agents/skills/docs-planner

Installed? Explore more Redacción y edición skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

¿Qué hace Planificador de Documentación?

Identifica brechas en el sitio de documentación y produce un backlog priorizado.

Entradas

  • Ámbito: Área a evaluar — toda la documentación, una sección específica o un área funcional. Por defecto: todo.
  • Señales (opcional): Issues de GitHub, preguntas de la comunidad, hilos de soporte.
  • Contexto competitivo (opcional): Lo que documentan los competidores y nosotros no.

Proceso

Paso 1: Inventario de la documentación actual

Lee site/src/config/navigation.yml para el árbol de navegación completo — esta es la fuente autoritativa de navegación para el sitio Astro, cargada por site/astro.config.mjs a través de site/src/sidebar.ts. Recorre globalmente site/src/content/docs/**/*.{md,mdx} para todos los archivos de contenido. Clasifica cada uno por tipo de contenido (tutorial, guía práctica, referencia, explicación, mixto) y área de cobertura (inicio rápido, herramientas, agentes, multiagente, despliegue, etc.).

Paso 2: Identificar brechas

Compara el inventario contra:

  • Superficie del SDK: ¿Están documentadas todas las funciones principales? Las funciones sin páginas de documentación son brechas.
  • Completitud de Diataxis: Para cada área funcional, ¿existe documentación en los cuatro tipos? Una función con referencia pero sin tutorial tiene una brecha.
  • Señales de la comunidad: Si GitHub CLI está disponible, extrae issues abiertos etiquetados como "documentation" de strands-agents/harness-sdk. Asigna preguntas a documentación existente (poco clara/difícil de encontrar) o a documentación faltante (brecha de contenido).
  • Comparación competitiva (si se proporciona): ¿Qué documentan LangChain, CrewAI, Anthropic y OpenAI sobre funciones equivalentes que nosotros no?

Paso 3: Priorizar

Puntúa cada brecha según el impacto en el desarrollador y el esfuerzo:

  • P0 (hacer ahora): Alto impacto, cualquier esfuerzo. Inicio rápido, primeros pasos, conceptos básicos.
  • P1 (hacer pronto): Impacto medio, esfuerzo bajo. Guías prácticas faltantes para tareas comunes.
  • P2 (planificar): Impacto medio, esfuerzo alto. Nuevos tutoriales, explicaciones arquitectónicas.
  • P3 (backlog): Impacto bajo. Escenarios nicho, documentación de casos extremos.

Paso 4: Generar el backlog

Salida en markdown:

## Backlog de Docs: [Ámbito]

**Generado:** [fecha]
**Páginas inventariadas:** [cantidad]
**Brechas identificadas:** [cantidad]

### P0: Hacer Ahora
- [ ] [Tarea] — [tipo de contenido] — [página objetivo] — [motivo]

### P1: Hacer Pronto
- [ ] [Tarea] — [tipo de contenido] — [página objetivo] — [motivo]

### P2: Planificar
- [ ] [Tarea] — [tipo de contenido] — [página objetivo] — [motivo]

### P3: Backlog
- [ ] [Tarea] — [tipo de contenido] — [página objetivo] — [motivo]

### Matriz de Cobertura

| Área Funcional | Tutorial | Guía Práctica | Referencia | Explicación |
|---|---|---|---|---|
| Conceptos básicos de agentes | Y | ~ | Y | N |
| Herramientas personalizadas | Y | Y | Y | N |
| Multiagente | ~ | N | Y | ~ |

### Información basada en Señales
- [Tema de señales de la comunidad mapeado a brechas de documentación específicas]

Lo que ESTA Habilidad NO HACE

  • No escribe documentación (use escritor-de-docs para eso)
  • No requiere pipelines externos de señales (funciona solo con el inventario local)
  • No crea tareas automáticamente en herramientas externas

Skills relacionados