documentation
Générer une documentation pour le code TypeScript
También disponible en: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,BfdCampos,sickn33
La rédaction de documentation prend du temps au détriment du codage. Cette compétence fournit des modèles experts pour les commentaires TSDoc, les stories Storybook, les guides VitePress et les références d'API TypeDoc afin que vous puissiez documenter plus rapidement.
Descargar el ZIP de la skill
Subir en Claude
Ve a Configuración → Capacidades → Skills → Subir skill
Activa y empieza a usar
Pruébalo
Usando "documentation". Documenter cette fonction qui récupère les données utilisateur
Resultado esperado:
- Brève description de ce que fait la fonction
- @param userId - L'identifiant unique de l'utilisateur
- @returns Promise résolvant vers l'objet de données utilisateur
- @example const user = fetchUserById('123');
Usando "documentation". Créer une story Storybook pour un composant Button
Resultado esperado:
- Configuration Meta avec le titre 'Components/Button'
- Story par défaut sans args
- Variante de chargement avec la prop isLoading: true
- Variante désactivée avec la prop isDisabled: true
Auditoría de seguridad
SeguroPure documentation template skill with no executable code. All 53 static findings are false positives: SHA-256 hashes were misidentified as weak crypto, markdown code fences were misidentified as shell execution, and metadata fields were misidentified as security risks. The skill only contains documentation templates for TSDoc, Storybook, VitePress, and TypeDoc.
Factores de riesgo
⚡ Contiene scripts
🌐 Acceso a red
📁 Acceso al sistema de archivos
🔑 Variables de entorno
⚙️ Comandos externos
Puntuación de calidad
Lo que puedes crear
Documenter les fonctions exportées
Ajouter des commentaires TSDoc aux fonctions avec les paramètres, les types de retour et les exemples
Créer des stories de composants
Écrire des stories Storybook pour les composants React avec les args et les variantes
Construire la documentation de référence d'API
Générer la documentation d'API TypeDoc à partir des commentaires TSDoc
Prueba estos prompts
Ajouter des commentaires TSDoc à cette fonction avec les balises @param, @returns et @example.
Créer une story Storybook pour ce composant React avec les états par défaut, de chargement et d'erreur.
Ajouter une documentation TSDoc à ce hook personnalisé incluant les options, les valeurs de retour et un exemple d'utilisation.
Générer la documentation d'API TypeDoc et mettre à jour la barre latérale VitePress pour ce composant.
Mejores prácticas
- Inclure des balises @example avec des extraits de code exécutables
- Documenter toutes les fonctions et types exportés
- Utiliser un format TSDoc cohérent dans votre base de code
- Exécuter 'pnpm docs:api' après avoir ajouté des commentaires TSDoc
Evitar
- Oublier les balises @param ou @returns pour les fonctions complexes
- Écrire des descriptions vagues sans contexte
- Oublier de mettre à jour Storybook quand les props du composant changent
- Ne pas exécuter TypeDoc pour régénérer la documentation d'API
Preguntas frecuentes
Avec quels outils cette compétence fonctionne-t-elle ?
Quels types de fichiers cette compétence peut-elle documenter ?
Cette compétence peut-elle analyser du code existant ?
Mes données de code sont-elles en sécurité ?
Pourquoi mes docs n'apparaissent-elles pas ?
En quoi est-ce différent de GitHub Copilot ?
Detalles del desarrollador
Autor
CrazySwamiLicencia
MIT
Repositorio
https://github.com/CrazySwami/cross-platform-web-app-research/tree/master/.claude/skills/documentationRef.
master
Estructura de archivos
📄 SKILL.md