Intégration au code source

Niveau : PUISSANT
Catégorie : Ingénierie
Domaine : Documentation / Expérience développeur

Présentation

Analysez une base de code et générez une documentation d’intégration destinée aux ingénieurs, aux responsables techniques et aux prestataires. Cette compétence est optimisée pour une collecte rapide d’informations et la production de documents d’intégration reproductibles.

Capacités principales

• Identification de l’architecture et de la pile technique à partir des signaux du référentiel
• Inventaire des fichiers et des configurations clés pour les nouveaux contributeurs
• Configuration locale et génération de guides pour les tâches courantes
• Structuration de la documentation adaptée au public cible
• Création d’une structure de liste de contrôle pour le débogage et les contributions

Quand l’utiliser

• Lors de l’intégration d’un nouveau membre de l’équipe ou d’un prestataire
• Remise à jour de la documentation de projet obsolète après une refonte majeure
• Préparation de la documentation interne de transfert de tâches
• Création d’un dossier d’intégration standardisé pour les services

Mise en route rapide

# 1) Recueillir des informations sur la base de code
python3 scripts/codebase_analyzer.py /chemin/vers/le/dépôt

# 2) Exporter les résultats sous un format lisible par machine
python3 scripts/codebase_analyzer.py /chemin/vers/le/dépôt --json

# 3) Utiliser le modèle pour rédiger les documents d'intégration
# Voir references/onboarding-template.md

Workflow recommandé

1. Exécutez scripts/codebase_analyzer.py sur le dépôt cible.
2. Recueillez les informations clés : nombre de fichiers, langages détectés, fichiers de configuration, structure de haut niveau.
3. Remplissez le modèle d'intégration disponible dans references/onboarding-template.md.
4. Adaptez le niveau de détail des informations en fonction du public :
   • Junior : configuration + lignes directrices
   • Senior : architecture + aspects opérationnels
   • Prestataire : périmètre de responsabilité + limites d’intégration

Modèle de document d’intégration

Le modèle détaillé et des exemples de sections sont disponibles à l'adresse suivante :

• references/onboarding-template.md
• references/output-format-templates.md

Pièges courants

• Rédiger des documents sans valider les commandes de configuration sur un environnement vierge
• Mélanger des analyses approfondies de l’architecture avec des documents destinés aux prestataires
• Omettre les étapes de dépannage et de vérification
• Laisser les documents d’intégration se décaler par rapport à l’état actuel du dépôt

Bonnes pratiques

1. Veillez à ce que les instructions d’installation soient exécutables et limitées dans le temps.
2. Documenter le « pourquoi » des décisions architecturales clés.
3. Mettez à jour la documentation dans la même pull request que les modifications de comportement.
4. Considérez les documents d’intégration comme des ressources opérationnelles évolutives, et non comme des livrables ponctuels.