Générer documentation de composant

VérifiéSûr

Génère la documentation pour les nouveaux composants en suivant les motifs existants et en référençant les implémentations.

Spar Skills Guide Bot
DocumentationDébutant
27/07/2026
Claude CodeCursorCopilot
#component-docs#markdown#api-reference#rust#style-conventions

Recommandé pour

Synthèse automatique

Génère la documentation markdown d'un nouveau composant en s'alignant sur les fichiers existants du dossier docs et sur l'implémentation de story portant le même nom.

Points forts

  • Impose de reprendre les conventions déjà en place dans docs (par exemple button.md ou accordion.md)
  • Ancre la rédaction dans une implémentation réelle située dans crates/story/src/stories
  • Définit une structure attendue claire : description, props/API, exemples d'usage, exemples visuels
  • Prévoit des liens vers docs.rs pour les références d'API lorsque c'est pertinent

Limites

  • La qualité dépend fortement de la cohérence des docs existantes qui servent de modèle
  • Suppose qu'une story du même nom existe déjà dans crates/story/src/stories
  • Ne décrit aucune étape de vérification, de build ou de lint de la documentation produite
Quand l'utiliser

À utiliser lorsqu'un nouveau composant dispose déjà d'une story et que l'on veut rédiger sa documentation en suivant les conventions du dossier docs.

Quand l'éviter

À éviter si le composant n'a pas de story correspondante ou si la documentation doit suivre un cahier des charges externe absent du dossier docs.

Analyse de sécurité

Sûr
Score qualité78/100

The skill only provides documentation-generation guidance and does not instruct any destructive, network, exfiltration, or tool-execution behavior. No allowed tools are declared, so there is no meaningful execution risk.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

New component docs
Write documentation for the new Tooltip component, following the style of the existing files in the docs folder such as button.md and accordion.md.
From story to docs
Generate component docs for Slider based on its story implementation in crates/story/src/stories, including props, usage, and examples.
Add API links
Update the docs for the Dialog component to add a props/API section with docs.rs links, matching the docs folder patterns.

name: generate-component-documentation description: Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.

Instructions

When generating documentation for a new component:

  1. Follow existing patterns: Use the documentation styles found in the docs folder (examples: button.md, accordion.md, etc.)
  2. Reference implementations: Base the documentation on the same-named story implementation in crates/story/src/stories
  3. API references: Use markdown code blocks with links to docs.rs for component API references when applicable

Examples

The generated documentation should include:

  • Component description and purpose
  • Props/API documentation
  • Usage examples
  • Visual examples (if applicable)

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/generate-component-documentation-ms2s7cfy' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/generate-component-documentation-ms2s7cfy/download' --output '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md.part' && mv '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md.part' '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && test -s '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/generate-component-documentation' && cp -R '.skill-downloads/generate-component-documentation-ms2s7cfy' '.claude/skills/generate-component-documentation'

Cursor
test -f '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && test -s '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/generate-component-documentation' && cp -R '.skill-downloads/generate-component-documentation-ms2s7cfy' '.cursor/skills/generate-component-documentation'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/generate-component-documentation-ms2s7cfy'

openskills read 'generate-component-documentation-ms2s7cfy'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires