github/create-oo-component-documentation

Que fait create-oo-component-documentation ?

Crée une documentation complète et standardisée pour les composants orientés objet, en respectant les meilleures pratiques de l'industrie et les normes de documentation architecturale.

Vue d'ensemble

Cette compétence automatise la génération de documentation technique pour les composants orientés objet (classes, interfaces, énumérations, structures). Elle analyse le code source, extrait les métadonnées pertinentes (hiérarchies, signatures de méthodes, dépendances) et produit un document Markdown structuré. Le résultat est prêt à être utilisé dans les projets GitHub, les wikis, ou les systèmes de documentation comme Docusaurus.

Utilisation

Exemple de commande :

# Générer la documentation pour le répertoire courant
agent run github/create-oo-component-documentation --path .

Fonctionnalités

• Analyse automatique : Détection des classes, interfaces, attributs, méthodes et leurs relations.
• Format standard : Documentation conforme aux conventions UML et normes architecturales (Clean Architecture, Hexagonale, etc.).
• Support multi-langage : Compatible Java, Python, C#, TypeScript, C++, et autres langages OO.
• Intégration CI/CD : Peut être exécuté dans une pipeline GitHub Actions pour maintenir la documentation à jour.

Guide de démarrage rapide

1. Clonez le dépôt contenant vos composants orientés objet.
2. Exécutez la compétence sur le répertoire racine.
3. Consultez le fichier généré (par défaut DOCUMENTATION.md).
4. Intégrez-le à votre flux de travail.

Exemple de sortie

# Composant : UtilisateurService

**Package** : `com.example.services`
**Type** : Classe
**Hérite de** : `BaseService`
**Implémente** : `IUtilisateurService`

### Attributs

| Nom | Type | Visibilité | Description |
|-----|------|------------|-------------|
| `repository` | `IUtilisateurRepository` | privé | Référentiel de données |

### Méthodes

- `creerUtilisateur(nom: String, email: String): Utilisateur`
  - Crée un nouvel utilisateur dans le système.
  - **Exceptions** : `ValidationException`, `EmailExisteException`

### Dépendances

- `IUtilisateurRepository`
- `EmailService`

Configuration

Variables d'environnement ou arguments supplémentaires :

• OUTPUT_FILE : Chemin du fichier de sortie (défaut : DOCUMENTATION.md).
• LANGUAGE : Langage cible pour la documentation (ex : fr, en).

Ressources

• Documentation officielle
• Exemples de projets

---

Compétence créée pour les développeurs souhaitant une documentation architecturale fiable et automatisée.