4 min lecture • Guide 757 of 877
Gestion des Connaissances pour les Équipes de Développement
La connaissance sort par la porte quand les gens partent. GitScrum aide les équipes à documenter les décisions, processus et apprentissages là où le travail se passe.
Types de Connaissances
Quoi Documenter
CATÉGORIES DE DOCUMENTATION:
┌─────────────────────────────────────────────────────────────┐
│ │
│ ARCHITECTURE & DESIGN: │
│ • Diagrammes d'architecture système │
│ • Documentation API │
│ • Modèles de données │
│ • Architecture Decision Records (ADRs) │
│ • Choix technologiques et justification │
│ │
│ PROCESSUS: │
│ • Procédures de déploiement │
│ • Runbooks d'astreinte │
│ • Guidelines revue de code │
│ • Rituels sprint │
│ • Réponse aux incidents │
│ │
│ ONBOARDING: │
│ • Guides de configuration │
│ • Normes et attentes équipe │
│ • Contacts clés et rôles │
│ • Checklist première semaine │
│ • Pièges courants │
│ │
│ DÉCISIONS: │
│ • Pourquoi on a choisi X plutôt que Y │
│ • Contexte qui a informé les décisions │
│ • Compromis considérés │
│ • Quand revisiter les décisions │
│ │
│ APPRENTISSAGES: │
│ • Insights post-mortem │
│ • Actions rétrospectives │
│ • Connaissances tribales │
│ • Trucs et astuces │
└─────────────────────────────────────────────────────────────┘
Emplacements de Documentation
OÙ VIT LA CONNAISSANCE:
┌─────────────────────────────────────────────────────────────┐
│ │
│ DANS LE REPO CODE: │
│ │
│ /docs │
│ ├── README.md Démarrage rapide │
│ ├── CONTRIBUTING.md Comment contribuer │
│ ├── architecture/ │
│ │ ├── overview.md Architecture système │
│ │ └── decisions/ ADRs │
│ │ ├── 001-use-postgres.md │
│ │ └── 002-auth-approach.md │
│ ├── api/ Documentation API │
│ └── runbooks/ Guides opérationnels │
│ │
│ DANS WIKI/NOTION: │
│ │
│ Handbook Équipe │
│ ├── Processus équipe │
│ ├── Calendrier réunions │
│ ├── Rôles et responsabilités │
│ └── Guide d'onboarding │
│ │
│ DANS GITSCRUM: │
│ │
│ • Contexte et exigences tâches │
│ • Historique discussions │
│ • Justification décisions │
│ • Liens vers docs pertinentes │
│ │
│ PRINCIPE: │
│ Docs techniques → près du code │
│ Docs processus → wiki partagé │
│ Contexte tâches → GitScrum │
└─────────────────────────────────────────────────────────────┘
Architecture Decision Records
Format ADR
ARCHITECTURE DECISION RECORD:
┌─────────────────────────────────────────────────────────────┐
│ ADR-002: Utiliser PostgreSQL pour Base de Données Primaire │
├─────────────────────────────────────────────────────────────┤
│ │
│ STATUT: Accepté │
│ DATE: 2024-01-15 │
│ AUTEURS: @alex, @marie │
│ │
│ ═══════════════════════════════════════════════════════════ │
│ │
│ CONTEXTE: │
│ On a besoin d'une base primaire pour données utilisateurs, │
│ projets et tâches. On attend 100K utilisateurs an 1, │
│ 1M d'ici an 3. L'équipe a de l'expérience MySQL et PG. │
│ │
│ DÉCISION: │
│ On utilisera PostgreSQL comme base de données primaire. │
│ │
│ JUSTIFICATION: │
│ • Meilleur support JSON pour schémas flexibles │
│ • Capacités recherche full-text supérieures │
│ • Forte conformité ACID │
│ • Bonne performance à notre échelle attendue │
│ • Familiarité équipe │
│ │
│ ALTERNATIVES CONSIDÉRÉES: │
│ │
│ MySQL: │
│ • Pro: Légèrement plus d'expérience équipe │
│ • Con: Support JSON plus faible │
│ • Con: Besoin solution recherche séparée │
│ │
│ MongoDB: │
│ • Pro: Schéma flexible │
│ • Con: Préoccupations cohérence éventuelle │
│ • Con: Moins d'expérience équipe │
│ │
│ CONSÉQUENCES: │
│ • Besoin hébergement PostgreSQL (RDS) │
│ • Formation équipe sur fonctionnalités spécifiques PG │
│ • Peut exploiter JSONB pour champs extensibles │
│ │
│ DATE REVUE: 2025-01-15 (ou à 500K utilisateurs) │
└─────────────────────────────────────────────────────────────┘