C4 Code Level: [Directory Name]
Générer la documentation du code C4
Les bases de code manquent de documentation structurée et cohérente au niveau du code. Cette compétence crée une documentation complète de code C4 avec les signatures de fonctions, les hiérarchies de classes et les diagrammes visuels.
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 "C4 Code Level: [Directory Name]". Analyser le répertoire src/api et créer une documentation au niveau du code C4
Résultat attendu:
Documentation complète incluant les signatures de fonctions avec les paramètres et les types de retour, les définitions de classes avec les méthodes, les listes de dépendances, et un diagramme de classes Mermaid montrant la structure de la couche API.
Utilisation de "C4 Code Level: [Directory Name]". Créer un diagramme de pipeline de données pour les transformateurs ETL
Résultat attendu:
Diagramme de flux Mermaid montrant le pipeline de transformation des données depuis l'entrée brute jusqu'aux étapes de validation, transformation, normalisation et agrégation jusqu'à la sortie finale.
Audit de sécurité
SûrThis is a prompt-only documentation skill with no executable code, network access, or external dependencies. Static analysis found zero security issues. The skill provides templates and guidance for creating C4 code-level documentation using Mermaid diagrams.
Score de qualité
Ce que vous pouvez construire
Documenter les nouveaux modules de code
Lors de l'ajout de nouvelles fonctionnalités à une base de code, générer une documentation de code C4 pour maintenir des normes de documentation cohérentes pour les nouveaux modules.
Intégrer les nouveaux membres de l'équipe
Créer une documentation de code complète pour les parties inconnues de la base de code afin d'aider les nouveaux développeurs à comprendre rapidement la structure.
Préparer le code pour le transfert
Générer une documentation complète du code avant de transférer la propriété des modules entre équipes ou entrepreneurs.
Essayez ces prompts
Analyser le répertoire src/auth et créer une documentation au niveau du code C4 montrant toutes les fonctions, leurs signatures et leurs dépendances.
Documenter le code de la couche de service avec les hiérarchies de classes complètes, les implémentations d'interfaces et un diagramme de classes Mermaid.
Analyser le pipeline ETL dans src/pipeline et créer un diagramme de flux de données montrant toutes les fonctions de transformation et leur composition.
Documenter l'ensemble du package handlers incluant toutes les structs, les méthodes, les dépendances de fonctions, et créer à la fois un diagramme de structure de module et un graphe de dépendances de fonctions.
Bonnes pratiques
- Toujours inclure les signatures de fonctions complètes avec tous les types de paramètres et types de retour
- Utiliser des conventions de nommage cohérentes à travers tous les éléments de la documentation
- Inclure les chemins de fichiers réels et les numéros de ligne pour les références de code
Éviter
- Créer une documentation sans examiner le code source réel
- Utiliser des diagrammes trop complexes pour des structures de code simples
- Omettre les informations de dépendances dont les développeurs ont besoin pour comprendre le code