documentation-generation-doc-generate
Générer une documentation complète à partir du code
Maintenez votre documentation synchronisée avec le code automatiquement. Cette compétence extrait des informations du code source pour créer des spécifications d'API, des diagrammes d'architecture et des guides utilisateur qui restent à jour à mesure que votre base de code évolue.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "documentation-generation-doc-generate". Analyser les routes API Python dans src/routes/
Résultat attendu:
- Fichier de spécification OpenAPI 3.0 (openapi.yaml)
- Page de documentation API interactive HTML
- Exemples de code en Python, JavaScript et cURL pour chaque point de terminaison
Utilisation de "documentation-generation-doc-generate". Documenter l'architecture des microservices
Résultat attendu:
- Diagramme d'architecture système montrant les relations entre services
- Documentation des composants avec les piles technologiques et les responsabilités
- Diagrammes de flux de données pour les processus métier clés
Audit de sécurité
SûrThis skill contains documentation templates and example code snippets in markdown format. All detected patterns (shell commands, network calls, crypto references) exist within markdown code blocks as illustrative examples, not executable code. No actual security risks identified.
Score de qualité
Ce que vous pouvez construire
Génération de documentation API
Générer automatiquement des spécifications OpenAPI et une documentation API interactive à partir des annotations de votre base de code et des définitions de routes.
Documentation d'architecture
Créer des diagrammes d'architecture système et une documentation des composants en analysant les imports, les dépendances et la structure du code.
Automatisation des pipelines de documentation
Configurer des workflows CI/CD qui régénèrent et déploient la documentation à chaque commit de code pour garder les docs synchronisés.
Essayez ces prompts
Analyser les fichiers Python dans le répertoire ./src/api/ et générer une spécification OpenAPI 3.0 avec tous les points de terminaison, les schémas demande/réponse et les exigences d'authentification.
Créer un README.md complet pour ce dépôt incluant les instructions d'installation, les options de configuration, les exemples d'utilisation et les lignes directrices de contribution basées sur la structure du code.
Examiner les modules de service et leurs imports pour créer des diagrammes Mermaid montrant l'architecture système, le flux de données et les dépendances des composants.
Générer une documentation complète incluant la référence API, la vue d'ensemble de l'architecture, le guide de démarrage et les instructions de déploiement. Configurer un site de documentation en utilisant les artefacts générés avec une fonctionnalité de recherche.
Bonnes pratiques
- Exécuter la génération de documentation dans le cadre de CI/CD pour garder les docs synchronisés avec les modifications du code
- Inclure des vérifications de couverture de documentation qui font échouer les builds lorsque la couverture descend sous le seuil
- Vérifier la documentation générée pour sa précision et ajouter du contexte humain où nécessaire
Éviter
- Générer la documentation une seule fois et ne jamais la mettre à jour à mesure que le code évolue
- Publier la documentation générée sans vérification humaine pour la précision
- Inclure des informations sensibles comme les clés API ou les URL internes dans les docs générés