architecture-decision-record
Documenter les décisions architecturales avec des ADR
Les équipes ont du mal à se souvenir pourquoi des décisions architecturales ont été prises, ce qui entraîne des débats répétés et des reprises. Cette compétence fournit des modèles et des exemples pour créer des Architecture Decision Records qui capturent le contexte, les alternatives et les compromis afin que les équipes maintiennent une mémoire architecturale pour référence future.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "architecture-decision-record". Create an ADR for choosing PostgreSQL as our primary database
النتيجة المتوقعة:
- L'ADR inclura : Statut (Accepted), Contexte avec exigences et contraintes, section Décision avec choix technologiques spécifiques, Conséquences (positives, négatives, neutres), Alternatives envisagées (MySQL, MongoDB, DynamoDB) avec avantages/inconvénients et justification du rejet, Références à la documentation
استخدام "architecture-decision-record". Document our microservices migration decision
النتيجة المتوقعة:
- L'ADR couvrira : Contexte du problème (problèmes d'évolutivité, goulots d'étranglement de déploiement), Décision d'adopter les microservices avec une stack technologique spécifique, Conséquences avec des compromis honnêtes, Alternatives évaluées (optimiser le monolithe, serverless) avec raisons du rejet
التدقيق الأمني
آمنPure documentation skill containing only markdown templates and guidance. No executable code, scripts, network operations, or file system access. All static scanner findings are false positives caused by the scanner misinterpreting markdown syntax and documentation text as code/security issues. Prior audit correctly identified this as safe with zero risk factors.
عوامل الخطر
⚙️ الأوامر الخارجية (39)
🌐 الوصول إلى الشبكة (18)
درجة الجودة
ماذا يمكنك بناءه
Documenter l'architecture du système
Enregistrer les principaux choix architecturaux avec tout le contexte pour référence de l'équipe et alignement des parties prenantes
Établir des standards techniques
Créer des enregistrements des décisions de sélection de technologies incluant les choix de base de données, framework et infrastructure
Capturer la justification des décisions
Documenter pourquoi certaines approches ont été choisies afin que les futurs membres de l'équipe comprennent le raisonnement
جرّب هذه الموجهات
Créez un ADR pour documenter notre décision de sélection de base de données entre PostgreSQL, MongoDB et DynamoDB. Incluez le contexte de notre architecture microservices, les exigences de conformité ACID et la comparaison des compromis.
Documentez notre décision de stratégie de versionnement d'API. Comparez le versionnement par chemin d'URL versus le versionnement basé sur les en-têtes versus le versionnement par paramètres de requête. Expliquez pourquoi nous avons choisi le versionnement par chemin d'URL.
Créez un ADR pour migrer d'un monolithe vers des microservices. Incluez l'approche du pattern strangler fig, un plan de mise en œuvre phase par phase, et une évaluation honnête des conséquences.
Documentez la sélection de notre stack technologique pour un nouveau service backend. Couvrez les choix de langage de programmation, framework, base de données et infrastructure de déploiement avec une justification claire pour chaque décision.
أفضل الممارسات
- Rédigez les ADR au présent comme des enregistrements historiques qui capturent les décisions au moment où elles ont été prises
- Documentez au moins deux alternatives avec des avantages et des inconvénients honnêtes pour démontrer une évaluation approfondie
- Gardez les ADR immuables après acceptation - créez de nouveaux ADR pour remplacer plutôt que modifier ceux existants
تجنب
- Utiliser un langage vague comme "nous pourrions envisager d'utiliser" au lieu de décisions claires comme "nous adopterons"
- Lister uniquement des conséquences positives sans reconnaître honnêtement les coûts, les risques et les compromis
- Ignorer les alternatives ou présenter uniquement des options manifestement inférieures comme hommes de paille