CommunityRédaction et éditiongithub.com

Planificateur de Documentation

Identifiez les lacunes de la documentation et hiérarchisez le backlog. À utiliser lors de la planification d'un sprint d'amélioration de la documentation, après des signaux de friction récurrente, lors de l'expédition de nouvelles fonctionnalités SDK sans documentation, ou pour une évaluation périodique de la santé. Se déclenche également sur "planifier le travail de doc", "quelle documentation écrire", "hiérarchiser le backlog", "contrôle de santé de la doc", "que devrions-nous documenter ensuite".

Qu'est-ce que Planificateur de Documentation ?

Cette compétence analyse l'état de la documentation d'un site SDK (par exemple, strands-agents/harness-sdk) pour identifier les lacunes et produire un backlog priorisé. Elle est utile pour les responsables de documentation, les développeurs et les responsables produit qui souhaitent s'assurer que tous les aspects du SDK sont correctement documentés. La compétence prend en charge l'inventaire de la navigation et du contenu, l'identification des lacunes par rapport à la surface SDK, les types Diataxis, les signaux communautaires (problèmes GitHub) et les comparaisons concurrentielles. Enfin, elle hiérarchise les lacunes en fonction de l'impact et de l'effort (de P0 à P3) et produit un rapport Markdown prêt à l'emploi.

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

Installed? Explore more Rédaction et édition skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Que fait Planificateur de Documentation ?

Identifiez les lacunes du site de documentation et produisez un backlog priorisé.

Entrées

  • Périmètre : Zone à évaluer — toute la documentation, une section spécifique ou un domaine fonctionnel. Par défaut : tout.
  • Signaux (optionnel) : Problèmes GitHub, questions de la communauté, fils de support.
  • Contexte concurrentiel (optionnel) : Ce que les concurrents documentent et que nous ne documentons pas.

Processus

Étape 1 : Inventaire de la documentation actuelle

Lisez site/src/config/navigation.yml pour l'arborescence de navigation complète — c'est la source de navigation de référence pour le site Astro, chargée par site/astro.config.mjs via site/src/sidebar.ts. Parcourez site/src/content/docs/**/*.{md,mdx} pour tous les fichiers de contenu. Classez chaque fichier par type de contenu (didacticiel, guide pratique, référence, explication, mixte) et par domaine couvert (démarrage rapide, outils, agents, multi-agents, déploiement, etc.).

Étape 2 : Identifier les lacunes

Comparez l'inventaire avec :

  • Surface fonctionnelle du SDK : Toutes les fonctionnalités majeures sont-elles documentées ? Les fonctionnalités sans page de documentation sont des lacunes.
  • Complétude Diataxis : Pour chaque domaine fonctionnel, la documentation existe-t-elle dans les quatre types ? Une fonctionnalité avec une référence mais sans didacticiel présente une lacune.
  • Signaux de la communauté : Si GitHub CLI est disponible, extrayez les problèmes ouverts étiquetés "documentation" de strands-agents/harness-sdk. Mappez les questions à la documentation existante (peu claire/difficile à trouver) ou manquante (lacune de contenu).
  • Comparaison concurrentielle (si fournie) : Que documentent LangChain, CrewAI, Anthropic et OpenAI à propos de fonctionnalités équivalentes que nous ne documentons pas ?

Étape 3 : Hiérarchiser

Attribuez un score à chaque lacune en fonction de l'impact sur le développeur et de l'effort :

  • P0 (à faire maintenant) : Impact élevé, tout effort. Démarrage rapide, mise en route, concepts de base.
  • P1 (à faire bientôt) : Impact moyen, effort faible. Guides pratiques manquants pour les tâches courantes.
  • P2 (à planifier) : Impact moyen, effort élevé. Nouveaux didacticiels, explications architecturales.
  • P3 (backlog) : Impact faible. Scénarios de niche, documentation de cas limites.

Étape 4 : Produire le backlog

Produisez-le en Markdown :

## Backlog de Documentation : [Périmètre]

**Généré le :** [date]
**Pages inventoriées :** [nombre]
**Lacunes identifiées :** [nombre]

### P0 : À faire maintenant
- [ ] [Tâche] — [type de contenu] — [page cible] — [raison]

### P1 : À faire bientôt
- [ ] [Tâche] — [type de contenu] — [page cible] — [raison]

### P2 : À planifier
- [ ] [Tâche] — [type de contenu] — [page cible] — [raison]

### P3 : Backlog
- [ ] [Tâche] — [type de contenu] — [page cible] — [raison]

### Matrice de Couverture

| Domaine fonctionnel | Didacticiel | Guide pratique | Référence | Explication |
|---|---|---|---|---|
| Bases des agents | O | ~ | O | N |
| Outils personnalisés | O | O | O | N |
| Multi-agents | ~ | N | O | ~ |

### Informations issues des signaux
- [Thème issu des signaux de la communauté mappé à des lacunes documentaires spécifiques]

Ce que cette compétence NE FAIT PAS

  • N'écrit pas de documentation (utilisez plutôt docs-writer pour cela)
  • Ne nécessite pas de pipelines de signaux externes (fonctionne avec le seul inventaire local)
  • Ne crée pas automatiquement de tâches dans des outils externes

Skills associés