{ "source": { "repository": "https://github.com/APIOpsCycles/apiops-cycles-method-data", "commit": "4418d7ccff492f591957f0e53fd9d476354041d7" }, "locales": [ "en", "fi", "fr", "de", "pt" ], "defaultLocale": "en", "translations": { "fr": [ { "id": "capability-productization-cycle:question-template-markdown", "cycleId": "capability-productization-cycle", "kind": "questions", "format": "markdown", "title": "Cycle de productisation des capacités question template Markdown", "body": "# Cycle de productisation des capacités question template\n\nCycle pour transformer des capacites metier en capacites numeriques reutilisables avant de choisir le mode de mise en oeuvre.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\n## 1. Stratégie de capacité\n\nCadrer le besoin metier comme une capacite reutilisable avec une valeur, des utilisateurs, une responsabilite et des objectifs metier clairs avant de choisir le mode de mise en oeuvre.\n\n### Canvas questions\n#### Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n- **Persona**: Qui est le client type qui vit ce parcours?\n- **Le client découvre le besoin**: Comment le client reconnaît-il son besoin ou son problème?\n- **Le besoin du client est résolu**: Comment le besoin du client est-il finalement résolu?\n- **Étapes du parcours**: Quelles sont les étapes suivies par le client dans son parcours?\n- **Douleurs**: Quels sont les irritants ou défis du client?\n- **Gains**: Quels sont les gains ou bénéfices pour le client?\n- **Entrées et sorties**: Quelles sont les entrées et les sorties à chaque étape?\n- **Règles d'interaction et de traitement**: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Capability Value Proposition Canvas\nQuelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?\n- **Tâches et résultats des utilisateurs**: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?\n- **Fonctionnalités de capacité génératrices de gains**: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?\n- **Fonctionnalités de capacité qui réduisent les irritants**: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?\n- **Capacités réutilisables**: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?\n\n#### Capability Business Model Canvas\nDans quelle mesure cette capacité d’intégration doit-elle être viable, réutilisable, financée, possédée, accompagnée et découvrable ?\n- **Proposition de valeur de la capacité**: Quelle valeur cette capacité réutilisable apporte-t-elle aux utilisateurs et à l’organisation ou à l’écosystème ?\n- **Segments d’utilisateurs de la capacité**: Qui sont les utilisateurs actuels et potentiels de la capacité, y compris équipes, partenaires, systèmes, produits ou utilisateurs de données ?\n- **Engagement des utilisateurs**: Comment les utilisateurs découvriront-ils, évalueront-ils, demanderont-ils, onboarderont-ils, obtiendront-ils du support et donneront-ils du feedback sur la capacité ?\n- **Canaux**: Par quels catalogues, portails, marketplaces, sites de documentation, parcours de support ou processus de gouvernance les utilisateurs interagiront-ils avec la capacité ?\n- **Ressources clés**: Quels systèmes, actifs de données, plateformes, personnes, standards, financements et capacités opérationnelles sont nécessaires ?\n- **Activités clés**: Que doivent faire le responsable de la capacité et les producteurs pour concevoir, mettre à disposition, gouverner, accompagner et améliorer la capacité ?\n- **Partenaires clés**: Quels partenaires métier, technologie, données, sécurité, juridique, plateforme ou externes sont nécessaires pour faire fonctionner la capacité ?\n- **Bénéfices**: Quels bénéfices métier, opérationnels, écosystémiques, de réutilisation, de conformité ou de coût justifient la capacité ?\n- **Coûts**: Quels sont les coûts significatifs de construction, d’exploitation, de gouvernance, de support et d’évolution de la capacité ?\n\n## 2. Exigences utilisateurs & onboarding\n\nCapturez les exigences des utilisateurs, les besoins d’onboarding, les contraintes, les attentes de service et les responsabilités des fournisseurs.\n\n### Canvas questions\n#### Consumer Experience Requirements Canvas\nQuelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?\n- **Objectifs des utilisateurs**: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?\n- **Disponibilité et fraîcheur**: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?\n- **Volume et performance**: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?\n- **Qualité et cohérence des données**: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?\n- **Sécurité, protection des données et conformité**: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?\n- **Onboarding et accès**: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?\n- **Changement et versionnement**: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?\n- **Observabilité et support**: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?\n- **Reprise et continuité**: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?\n- **Implications d’architecture**: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?\n\n### Other related resources\n- **Meilleures pratiques en matière d'intégration de l'API**: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n\n## 3. Architecture & décisions de plateforme\n\nUtiliser les exigences et contraintes pour choisir le mode de mise en oeuvre, le pattern d architecture et les capacites de plateforme necessaires.\n\n### Canvas questions\n#### Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n- **Risques de disponibilité**: Quels sont les risques potentiels pour la disponibilité de l’API?\n- **Atténuer les risques de disponibilité**: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n- **Risques de sécurité**: Quels sont les risques de sécurité potentiels associés à l’API?\n- **Atténuer les risques de sécurité**: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n- **Risques liés aux données**: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n- **Atténuer les risques liés aux données**: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\n#### Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n- **Groupes de localisation / de confiance**: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n- **Caractéristiques des groupes**: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n- **Emplacements / Zones pertinents**: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n- **Caractéristiques des emplacements / zones**: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n- **Distances réseau / réglementaires**: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n- **Caractéristiques des distance**: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n- **Points de terminaison de connectivité**: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n- **Caractéristiques d'accès aux points de terminaison**: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\n#### Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n- **Volumes d'activité actuels**: Quels sont les volumes d'affaires et taux de transaction actuels?\n- **Tendances de consommation futures**: Quelles sont les tendances de consommation anticipées?\n- **Exigences de charge maximale et de disponibilité**: Quelles sont les exigences de charge maximale et de disponibilité?\n- **Stratégies de mise en cache**: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n- **Stratégies de limitation de débit**: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n- **Stratégies de montée en charge**: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\n## 4. Conception de solution & d’interface\n\nConcevoir le contrat d interface et le modele d interaction pour le mode de mise en oeuvre choisi.\n\n### Canvas questions\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n- **Interactions CRUD**: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n- **Modèles d'entrée et de sortie CRUD**: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n- **Traitement et validation CRUD**: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n- **Interactions pilotées par requêtes**: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n- **Modèles d'entrée et de sortie pilotés par les requêtes**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n- **Traitement et validation pilotés par les requêtes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n- **Interactions pilotées par commandes**: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par commande**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n- **Traitement et validation pilotés par les commandes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n- **Interactions pilotées par les événements**: Quels événements doivent être publiés ou consommés, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par les événements**: Modèles d'entrée et de sortie pilotés par les événements\n- **Traitement et validation pilotés par les événements**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\n### Other related resources\n- **Contrat de première conception**: Une ligne directrice qui préconise des approches \"API-first\" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.\n\n## 5. Mise à disposition & opérations\n\nConstruire, tester, deployer et exploiter la capacite avec le mode de mise en oeuvre choisi et le contrat d interface valide.\n\n### Station questions\n- Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.\n- Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.\n- Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n- Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n- S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n- Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n- Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.\n- Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.\n\n### Other related resources\n- **Meilleures pratiques en matière de développement d'API**: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.\n- **Meilleures pratiques de test de l'API**: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.\n- **APIOps CI/CD pour les API**: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n\n## 6. Assurance qualité & préparation\n\nValider le contrat d interface, les controles, la documentation, le modele de support et la preparation operationnelle avant publication.\n\n### Station questions\n- Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.\n- Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n- Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n- Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.\n- Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.\n\n### Other related resources\n- **Liste de contrôle de l'audit de l'API**: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n- **Meilleures pratiques en matière de conformité de l'API**: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\n## 7. Publication & enablement\n\nPublier la capacite afin que les utilisateurs puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, l utiliser et obtenir du support.\n\n### Station questions\n- Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.\n- Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n- Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n- Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.\n- Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.\n\n### Other related resources\n- **Meilleures pratiques en matière d'intégration de l'API**: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n- **Modèle de contrat de service**: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.\n\n## 8. Suivi & amélioration\n\nSuivez la santé de la capacité, les résultats utilisateurs, la fiabilité, la réutilisation et les opportunités d’amélioration.\n\n### Station questions\n- Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.\n- Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n- Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n- Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.\n- Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.\n\n### Other related resources\n- **Mesures et analyses de l'API**: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n- **Stratégies d'engagement de la communauté de l'API**: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social." }, { "id": "capability-productization-cycle:question-template-confluence-wiki", "cycleId": "capability-productization-cycle", "kind": "questions", "format": "confluence-wiki", "title": "Cycle de productisation des capacités question template Confluence wiki", "body": "h1. Cycle de productisation des capacités question template\n\nCycle pour transformer des capacites metier en capacites numeriques reutilisables avant de choisir le mode de mise en oeuvre.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\nh2. 1. Stratégie de capacité\n\nCadrer le besoin metier comme une capacite reutilisable avec une valeur, des utilisateurs, une responsabilite et des objectifs metier clairs avant de choisir le mode de mise en oeuvre.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n* *Persona*: Qui est le client type qui vit ce parcours?\n* *Le client découvre le besoin*: Comment le client reconnaît-il son besoin ou son problème?\n* *Le besoin du client est résolu*: Comment le besoin du client est-il finalement résolu?\n* *Étapes du parcours*: Quelles sont les étapes suivies par le client dans son parcours?\n* *Douleurs*: Quels sont les irritants ou défis du client?\n* *Gains*: Quels sont les gains ou bénéfices pour le client?\n* *Entrées et sorties*: Quelles sont les entrées et les sorties à chaque étape?\n* *Règles d'interaction et de traitement*: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Capability Value Proposition Canvas\nQuelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?\n* *Tâches et résultats des utilisateurs*: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?\n* *Fonctionnalités de capacité génératrices de gains*: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?\n* *Fonctionnalités de capacité qui réduisent les irritants*: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?\n* *Capacités réutilisables*: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?\n\nh4. Capability Business Model Canvas\nDans quelle mesure cette capacité d’intégration doit-elle être viable, réutilisable, financée, possédée, accompagnée et découvrable ?\n* *Proposition de valeur de la capacité*: Quelle valeur cette capacité réutilisable apporte-t-elle aux utilisateurs et à l’organisation ou à l’écosystème ?\n* *Segments d’utilisateurs de la capacité*: Qui sont les utilisateurs actuels et potentiels de la capacité, y compris équipes, partenaires, systèmes, produits ou utilisateurs de données ?\n* *Engagement des utilisateurs*: Comment les utilisateurs découvriront-ils, évalueront-ils, demanderont-ils, onboarderont-ils, obtiendront-ils du support et donneront-ils du feedback sur la capacité ?\n* *Canaux*: Par quels catalogues, portails, marketplaces, sites de documentation, parcours de support ou processus de gouvernance les utilisateurs interagiront-ils avec la capacité ?\n* *Ressources clés*: Quels systèmes, actifs de données, plateformes, personnes, standards, financements et capacités opérationnelles sont nécessaires ?\n* *Activités clés*: Que doivent faire le responsable de la capacité et les producteurs pour concevoir, mettre à disposition, gouverner, accompagner et améliorer la capacité ?\n* *Partenaires clés*: Quels partenaires métier, technologie, données, sécurité, juridique, plateforme ou externes sont nécessaires pour faire fonctionner la capacité ?\n* *Bénéfices*: Quels bénéfices métier, opérationnels, écosystémiques, de réutilisation, de conformité ou de coût justifient la capacité ?\n* *Coûts*: Quels sont les coûts significatifs de construction, d’exploitation, de gouvernance, de support et d’évolution de la capacité ?\n\nh2. 2. Exigences utilisateurs & onboarding\n\nCapturez les exigences des utilisateurs, les besoins d’onboarding, les contraintes, les attentes de service et les responsabilités des fournisseurs.\n\nh3. Canvas questions\nh4. Consumer Experience Requirements Canvas\nQuelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?\n* *Objectifs des utilisateurs*: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?\n* *Disponibilité et fraîcheur*: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?\n* *Volume et performance*: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?\n* *Qualité et cohérence des données*: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?\n* *Sécurité, protection des données et conformité*: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?\n* *Onboarding et accès*: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?\n* *Changement et versionnement*: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?\n* *Observabilité et support*: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?\n* *Reprise et continuité*: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?\n* *Implications d’architecture*: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?\n\nh3. Other related resources\n* *Meilleures pratiques en matière d'intégration de l'API*: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n\nh2. 3. Architecture & décisions de plateforme\n\nUtiliser les exigences et contraintes pour choisir le mode de mise en oeuvre, le pattern d architecture et les capacites de plateforme necessaires.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n* *Risques de disponibilité*: Quels sont les risques potentiels pour la disponibilité de l’API?\n* *Atténuer les risques de disponibilité*: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n* *Risques de sécurité*: Quels sont les risques de sécurité potentiels associés à l’API?\n* *Atténuer les risques de sécurité*: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n* *Risques liés aux données*: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n* *Atténuer les risques liés aux données*: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\nh4. Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n* *Groupes de localisation / de confiance*: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n* *Caractéristiques des groupes*: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n* *Emplacements / Zones pertinents*: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n* *Caractéristiques des emplacements / zones*: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n* *Distances réseau / réglementaires*: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n* *Caractéristiques des distance*: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n* *Points de terminaison de connectivité*: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n* *Caractéristiques d'accès aux points de terminaison*: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\nh4. Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n* *Volumes d'activité actuels*: Quels sont les volumes d'affaires et taux de transaction actuels?\n* *Tendances de consommation futures*: Quelles sont les tendances de consommation anticipées?\n* *Exigences de charge maximale et de disponibilité*: Quelles sont les exigences de charge maximale et de disponibilité?\n* *Stratégies de mise en cache*: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n* *Stratégies de limitation de débit*: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n* *Stratégies de montée en charge*: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\nh2. 4. Conception de solution & d’interface\n\nConcevoir le contrat d interface et le modele d interaction pour le mode de mise en oeuvre choisi.\n\nh3. Canvas questions\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n* *Interactions CRUD*: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n* *Modèles d'entrée et de sortie CRUD*: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n* *Traitement et validation CRUD*: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n* *Interactions pilotées par requêtes*: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n* *Modèles d'entrée et de sortie pilotés par les requêtes*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n* *Traitement et validation pilotés par les requêtes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n* *Interactions pilotées par commandes*: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par commande*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n* *Traitement et validation pilotés par les commandes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n* *Interactions pilotées par les événements*: Quels événements doivent être publiés ou consommés, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par les événements*: Modèles d'entrée et de sortie pilotés par les événements\n* *Traitement et validation pilotés par les événements*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\nh3. Other related resources\n* *Contrat de première conception*: Une ligne directrice qui préconise des approches \"API-first\" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.\n\nh2. 5. Mise à disposition & opérations\n\nConstruire, tester, deployer et exploiter la capacite avec le mode de mise en oeuvre choisi et le contrat d interface valide.\n\nh3. Station questions\n* Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.\n* Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.\n* Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n* Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n* S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n* Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n* Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.\n* Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.\n\nh3. Other related resources\n* *Meilleures pratiques en matière de développement d'API*: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.\n* *Meilleures pratiques de test de l'API*: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.\n* *APIOps CI/CD pour les API*: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n\nh2. 6. Assurance qualité & préparation\n\nValider le contrat d interface, les controles, la documentation, le modele de support et la preparation operationnelle avant publication.\n\nh3. Station questions\n* Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.\n* Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n* Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n* Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.\n* Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.\n\nh3. Other related resources\n* *Liste de contrôle de l'audit de l'API*: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n* *Meilleures pratiques en matière de conformité de l'API*: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\nh2. 7. Publication & enablement\n\nPublier la capacite afin que les utilisateurs puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, l utiliser et obtenir du support.\n\nh3. Station questions\n* Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.\n* Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n* Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n* Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.\n* Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.\n\nh3. Other related resources\n* *Meilleures pratiques en matière d'intégration de l'API*: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n* *Modèle de contrat de service*: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.\n\nh2. 8. Suivi & amélioration\n\nSuivez la santé de la capacité, les résultats utilisateurs, la fiabilité, la réutilisation et les opportunités d’amélioration.\n\nh3. Station questions\n* Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.\n* Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n* Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n* Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.\n* Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.\n\nh3. Other related resources\n* *Mesures et analyses de l'API*: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n* *Stratégies d'engagement de la communauté de l'API*: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social." }, { "id": "api-productization-cycle:question-template-markdown", "cycleId": "api-productization-cycle", "kind": "questions", "format": "markdown", "title": "Cycle de productisation des API question template Markdown", "body": "# Cycle de productisation des API question template\n\nParcours APIOps Cycles centré sur les API pour productiser, concevoir, livrer, publier et améliorer des produits API.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\n## 1. Stratégie produit API\n\nAvant de construire quoi que ce soit, définissez dès le départ la valeur de votre API, ses utilisateurs et ses objectifs métier.\n\n### Canvas questions\n#### Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n- **Persona**: Qui est le client type qui vit ce parcours?\n- **Le client découvre le besoin**: Comment le client reconnaît-il son besoin ou son problème?\n- **Le besoin du client est résolu**: Comment le besoin du client est-il finalement résolu?\n- **Étapes du parcours**: Quelles sont les étapes suivies par le client dans son parcours?\n- **Douleurs**: Quels sont les irritants ou défis du client?\n- **Gains**: Quels sont les gains ou bénéfices pour le client?\n- **Entrées et sorties**: Quelles sont les entrées et les sorties à chaque étape?\n- **Règles d'interaction et de traitement**: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### API Value Proposition Canvas\nComment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?\n- **Tâches**: Que cherchent à accomplir les clients ou utilisateurs finaux ?\n- **Fonctionnalités génératrices de gains**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?\n- **Fonctionnalités qui réduisent les irritants**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?\n- **Produits API**: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?\n\n#### API Business Model Canvas\nQuelle sera la viabilité et la réutilisabilité de cette API ? Existe-t-il un modèle métier justifié du point de vue coût-bénéfice ?\n- **Proposition de valeur de l’API**: Commencez par une note adhésive indiquant le nom de l’API ou de la famille d’API, puis notez la valeur ajoutée que l’API offre aux utilisateurs API.\n- **Segments d’utilisateurs API**: Quelles sont les audiences cibles pour l’API?\n- **Relations développeurs**: Comment le fournisseur d’API atteint-il et soutient-il les utilisateurs API?\n- **Canaux**: Par quels mécanismes les utilisateurs API interagissent-ils avec l’API?\n- **Ressources clés**: Quels actifs stratégiques uniques le fournisseur d’API doit-il acquérir ou développer?\n- **Activités clés**: Quelles sont les actions les plus importantes que le fournisseur d’API doit entreprendre pour réussir?\n- **Partenaires clés**: Qui sont les principales parties prenantes impliquées?\n- **Avantages**: Quels sont les avantages significatifs ou les sources de revenus générés par l’API?\n- **Coûts**: Quels sont les coûts importants liés à la création, au déploiement et à l'exploitation de l’API?\n\n## 2. Expérience utilisateur API\n\nVeillez à ce que votre API soit découvrable, compréhensible et utilisable - avant et après le lancement.\n\n### Canvas questions\n#### API Value Proposition Canvas\nComment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?\n- **Tâches**: Que cherchent à accomplir les clients ou utilisateurs finaux ?\n- **Fonctionnalités génératrices de gains**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?\n- **Fonctionnalités qui réduisent les irritants**: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?\n- **Produits API**: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?\n\n#### Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n- **Persona**: Qui est le client type qui vit ce parcours?\n- **Le client découvre le besoin**: Comment le client reconnaît-il son besoin ou son problème?\n- **Le besoin du client est résolu**: Comment le besoin du client est-il finalement résolu?\n- **Étapes du parcours**: Quelles sont les étapes suivies par le client dans son parcours?\n- **Douleurs**: Quels sont les irritants ou défis du client?\n- **Gains**: Quels sont les gains ou bénéfices pour le client?\n- **Entrées et sorties**: Quelles sont les entrées et les sorties à chaque étape?\n- **Règles d'interaction et de traitement**: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\n### Other related resources\n- **Meilleures pratiques en matière d'intégration de l'API**: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n\n## 3. Architecture de plateforme API\n\nAssurez l'évolutivité, la réutilisation et la gouvernance de vos composants d'API et de plateforme.\n\n### Canvas questions\n#### Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n- **Risques de disponibilité**: Quels sont les risques potentiels pour la disponibilité de l’API?\n- **Atténuer les risques de disponibilité**: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n- **Risques de sécurité**: Quels sont les risques de sécurité potentiels associés à l’API?\n- **Atténuer les risques de sécurité**: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n- **Risques liés aux données**: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n- **Atténuer les risques liés aux données**: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\n#### Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n- **Groupes de localisation / de confiance**: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n- **Caractéristiques des groupes**: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n- **Emplacements / Zones pertinents**: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n- **Caractéristiques des emplacements / zones**: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n- **Distances réseau / réglementaires**: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n- **Caractéristiques des distance**: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n- **Points de terminaison de connectivité**: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n- **Caractéristiques d'accès aux points de terminaison**: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\n#### Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n- **Volumes d'activité actuels**: Quels sont les volumes d'affaires et taux de transaction actuels?\n- **Tendances de consommation futures**: Quelles sont les tendances de consommation anticipées?\n- **Exigences de charge maximale et de disponibilité**: Quelles sont les exigences de charge maximale et de disponibilité?\n- **Stratégies de mise en cache**: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n- **Stratégies de limitation de débit**: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n- **Stratégies de montée en charge**: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\n### Other related resources\n- **Mesures et analyses de l'API**: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n\n## 4. Conception d’API\n\nCréer des architectures d'API cohérentes, réutilisables et fondées sur les objectifs métier et des normes communes.\n\n### Canvas questions\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n- **Interactions CRUD**: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n- **Modèles d'entrée et de sortie CRUD**: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n- **Traitement et validation CRUD**: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n- **Interactions pilotées par requêtes**: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n- **Modèles d'entrée et de sortie pilotés par les requêtes**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n- **Traitement et validation pilotés par les requêtes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n- **Interactions pilotées par commandes**: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par commande**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n- **Traitement et validation pilotés par les commandes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n- **Interactions pilotées par les événements**: Quels événements doivent être publiés ou consommés, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par les événements**: Modèles d'entrée et de sortie pilotés par les événements\n- **Traitement et validation pilotés par les événements**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\n#### REST Canvas\nComment concevoir l’API selon les principes RESTful ?\n- **Ressources API**: Quelles sont les ressources clés exposées par l’API?\n- **Modèle de ressource API**: Quelle est la structure du modèle de ressources de l’API?\n- **Verbes API**: Quels verbes HTTP sont utilisés pour interagir avec les ressources de l’API?\n- **Exemple de verbe API**: Fournissez un exemple de requête et de réponse API pour chaque verbe.\n\n#### Event Canvas\nQuels événements sont pertinents pour la capacité ou l’interface, et comment sont-ils traités ?\n- **Tâche utilisateur / Déclencheur**: Quelle action utilisateur ou événement système déclenche cette opération d'événement?\n- **Entrée / Charge utile de l'événement**: Quelles données sont incluses dans la charge utile de l'événement entrant? Spécifiez les attributs clés.\n- **Traitement / Logique**: Décrivez la logique de traitement systèmes backend, y compris les validations, transformations ou décisions de routage.\n- **Sortie / Résultat de l'événement**: Quel événement ou accusé de réception est produit? Incluez les attributs de la charge utile de sortie.\n\n#### GraphQL Canvas\nComment concevoir l’API selon les principes GraphQL ?\n- **Nom de l’API**: Quel est le nom de l’API GraphQL ou du point de terminaison ?\n- **Objectifs des utilisateurs**: Quels problèmes les utilisateurs de l’API cherchent-ils à résoudre ? Quelles données leur sont nécessaires ?\n- **Types clés**: Quels sont les types principaux exposés (ex. Utilisateur, Commande, Produit) ?\n- **Relations**: Comment les types sont-ils liés dans les requêtes imbriquées ?\n- **Requêtes**: Quelles requêtes courantes doivent être prises en charge ?\n- **Mutations**: Quelles opérations vont modifier les données (ex. créer, mettre à jour, supprimer) ?\n- **Abonnements**: Existe-t-il des mises à jour en temps réel ou des événements auxquels les utilisateurs peuvent s'abonner ?\n- **Règles d'autorisation**: Qui peut accéder à quels champs ou types ?\n- **Contraintes des utilisateurs**: Y a-t-il des contraintes de pagination, de filtrage ou de limitation du débit ?\n- **Notes / Questions ouvertes**: Y a-t-il des décisions en attente ou des considérations d’intégration ?\n\n### Other related resources\n- **Principes de conception de l'API**: Un guide concis sur l'ergonomie, la facilité de découverte et la cohérence des API, fondé sur des règles de conception communes et les besoins réels des consommateurs.\n- **Contrat de première conception**: Une ligne directrice qui préconise des approches \"API-first\" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.\n\n## 5. Livraison d’API\n\nConstruire, tester et publier des API en utilisant des pipelines de livraison modernes et les meilleures pratiques d'ingénierie.\n\n### Station questions\n- Utilisez les meilleures pratiques de développement d'API comme guide pour mettre en œuvre le contrat d'interface validé à l'aide de frameworks et de bibliothèques établis, en veillant à ce que le résultat soit réutilisable et maintenable.\n- Construisez l'implémentation de l'API à partir du contrat d'interface validé en utilisant des frameworks, des bibliothèques et des standards d'équipe établis.\n- Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n- Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n- S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n- Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n- Fournir des frameworks de développement, des bibliothèques et des normes pour la mise en œuvre des API. Mettre en œuvre des pipelines CI/CD, des cadres d'assurance qualité et des outils d'automatisation du déploiement.\n- Même les meilleures conceptions d'API échouent si la livraison est incohérente. Cette station garantit que vos API sont construites avec qualité, testées de manière approfondie et déployées de manière fiable, ce qui permet des itérations plus rapides et une plus grande confiance.\n\n### Other related resources\n- **Meilleures pratiques en matière de développement d'API**: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.\n- **Meilleures pratiques de test de l'API**: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.\n- **APIOps CI/CD pour les API**: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n- **Meilleures pratiques en matière de sécurité des API**: Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.\n\n## 6. Audit API\n\nVérifiez que les API répondent aux normes métier, de conception et opérationnelles avant leur publication et leur mise à disposition.\n\n### Station questions\n- Mener des audits pour s'assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d'être publiées.\n- Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n- Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n- Mettez en place un processus d'audit cohérent qui évalue l'état de préparation des API à toutes les étapes du cycle de vie à l'aide de critères, de preuves et de normes définis. Assurez-vous que les lacunes sont identifiées tôt et résolues avant la publication.\n- Les API sont des produits à longue durée de vie et doivent répondre aux attentes en matière de qualité, de cohérence et de conformité. L'audit relie les décisions de conception, la mise en œuvre et l'état de préparation opérationnelle à des normes définies, réduisant ainsi les risques avant la mise à disposition.\n\n### Other related resources\n- **Liste de contrôle de l'audit de l'API**: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n- **Meilleures pratiques en matière de conformité de l'API**: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\n## 7. Publication d’API\n\nExposer les API de manière sûre et claire au bon public avec la bonne documentation et les bons processus.\n\n### Station questions\n- Publier les API dans les passerelles et les environnements appropriés afin de favoriser la réutilisation pour de multiples utilisateurs.\n- Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n- Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n- Permettre aux API d'être publiées dans l'environnement approprié et disposer de mécanismes d'enregistrement et d'accès clairs (par exemple, clés API, OAuth, plans d'abonnement) en fonction des segments de utilisateurs et des exigences en matière de sécurité et de conformité.\n- La publication va plus loin que le déploiement - il s'agit de la découvrabilité, de l'accès et de l'assistance. Si les API ne sont pas publiées correctement, elles ne seront pas utilisées, réutilisées ou sécurisées efficacement.\n\n### Other related resources\n- **APIOps CI/CD pour les API**: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n- **Meilleures pratiques en matière d'intégration de l'API**: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n- **Liste de contrôle de l'audit de l'API**: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n\n## 8. Suivi & amelioration API\n\nUtiliser les mesures et le retour d'information pour suivre les performances de l'API et favoriser l'amélioration continue.\n\n### Station questions\n- Contrôler les indicateurs de performance (par exemple, les appels à l'API, la latence, les taux d'erreur) et les indicateurs d'adoption (par exemple, NPS).\n- Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n- Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n- Mettre en place des cadres d'analyse pour suivre les performances et l'engagement. Développer des boucles de rétroaction, des outils d'analyse et des stratégies d'engagement pour les API.\n- La livraison d'API ne s'arrête pas au lancement. Sans surveillance, les équipes ne peuvent pas améliorer l'adoption, les performances ou le retour sur investissement. Cette station garantit que les API restent utiles, sécurisées et qu'elles évoluent avec les besoins de l'entreprise.\n\n### Other related resources\n- **Mesures et analyses de l'API**: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n- **Stratégies d'engagement de la communauté de l'API**: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social." }, { "id": "api-productization-cycle:question-template-confluence-wiki", "cycleId": "api-productization-cycle", "kind": "questions", "format": "confluence-wiki", "title": "Cycle de productisation des API question template Confluence wiki", "body": "h1. Cycle de productisation des API question template\n\nParcours APIOps Cycles centré sur les API pour productiser, concevoir, livrer, publier et améliorer des produits API.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\nh2. 1. Stratégie produit API\n\nAvant de construire quoi que ce soit, définissez dès le départ la valeur de votre API, ses utilisateurs et ses objectifs métier.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n* *Persona*: Qui est le client type qui vit ce parcours?\n* *Le client découvre le besoin*: Comment le client reconnaît-il son besoin ou son problème?\n* *Le besoin du client est résolu*: Comment le besoin du client est-il finalement résolu?\n* *Étapes du parcours*: Quelles sont les étapes suivies par le client dans son parcours?\n* *Douleurs*: Quels sont les irritants ou défis du client?\n* *Gains*: Quels sont les gains ou bénéfices pour le client?\n* *Entrées et sorties*: Quelles sont les entrées et les sorties à chaque étape?\n* *Règles d'interaction et de traitement*: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. API Value Proposition Canvas\nComment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?\n* *Tâches*: Que cherchent à accomplir les clients ou utilisateurs finaux ?\n* *Fonctionnalités génératrices de gains*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?\n* *Fonctionnalités qui réduisent les irritants*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?\n* *Produits API*: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?\n\nh4. API Business Model Canvas\nQuelle sera la viabilité et la réutilisabilité de cette API ? Existe-t-il un modèle métier justifié du point de vue coût-bénéfice ?\n* *Proposition de valeur de l’API*: Commencez par une note adhésive indiquant le nom de l’API ou de la famille d’API, puis notez la valeur ajoutée que l’API offre aux utilisateurs API.\n* *Segments d’utilisateurs API*: Quelles sont les audiences cibles pour l’API?\n* *Relations développeurs*: Comment le fournisseur d’API atteint-il et soutient-il les utilisateurs API?\n* *Canaux*: Par quels mécanismes les utilisateurs API interagissent-ils avec l’API?\n* *Ressources clés*: Quels actifs stratégiques uniques le fournisseur d’API doit-il acquérir ou développer?\n* *Activités clés*: Quelles sont les actions les plus importantes que le fournisseur d’API doit entreprendre pour réussir?\n* *Partenaires clés*: Qui sont les principales parties prenantes impliquées?\n* *Avantages*: Quels sont les avantages significatifs ou les sources de revenus générés par l’API?\n* *Coûts*: Quels sont les coûts importants liés à la création, au déploiement et à l'exploitation de l’API?\n\nh2. 2. Expérience utilisateur API\n\nVeillez à ce que votre API soit découvrable, compréhensible et utilisable - avant et après le lancement.\n\nh3. Canvas questions\nh4. API Value Proposition Canvas\nComment le parcours client est-il lié aux API ? Quels irritants et gains des utilisateurs finaux et des utilisateurs API doivent être traités ?\n* *Tâches*: Que cherchent à accomplir les clients ou utilisateurs finaux ?\n* *Fonctionnalités génératrices de gains*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à obtenir les gains attendus ?\n* *Fonctionnalités qui réduisent les irritants*: Quelles fonctionnalités aident les utilisateurs finaux et les utilisateurs API à réduire les irritants ?\n* *Produits API*: Quels produits et fonctionnalités API répondent aux tâches, peines et gains?\n\nh4. Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n* *Persona*: Qui est le client type qui vit ce parcours?\n* *Le client découvre le besoin*: Comment le client reconnaît-il son besoin ou son problème?\n* *Le besoin du client est résolu*: Comment le besoin du client est-il finalement résolu?\n* *Étapes du parcours*: Quelles sont les étapes suivies par le client dans son parcours?\n* *Douleurs*: Quels sont les irritants ou défis du client?\n* *Gains*: Quels sont les gains ou bénéfices pour le client?\n* *Entrées et sorties*: Quelles sont les entrées et les sorties à chaque étape?\n* *Règles d'interaction et de traitement*: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\nh3. Other related resources\n* *Meilleures pratiques en matière d'intégration de l'API*: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n\nh2. 3. Architecture de plateforme API\n\nAssurez l'évolutivité, la réutilisation et la gouvernance de vos composants d'API et de plateforme.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n* *Risques de disponibilité*: Quels sont les risques potentiels pour la disponibilité de l’API?\n* *Atténuer les risques de disponibilité*: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n* *Risques de sécurité*: Quels sont les risques de sécurité potentiels associés à l’API?\n* *Atténuer les risques de sécurité*: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n* *Risques liés aux données*: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n* *Atténuer les risques liés aux données*: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\nh4. Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n* *Groupes de localisation / de confiance*: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n* *Caractéristiques des groupes*: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n* *Emplacements / Zones pertinents*: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n* *Caractéristiques des emplacements / zones*: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n* *Distances réseau / réglementaires*: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n* *Caractéristiques des distance*: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n* *Points de terminaison de connectivité*: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n* *Caractéristiques d'accès aux points de terminaison*: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\nh4. Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n* *Volumes d'activité actuels*: Quels sont les volumes d'affaires et taux de transaction actuels?\n* *Tendances de consommation futures*: Quelles sont les tendances de consommation anticipées?\n* *Exigences de charge maximale et de disponibilité*: Quelles sont les exigences de charge maximale et de disponibilité?\n* *Stratégies de mise en cache*: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n* *Stratégies de limitation de débit*: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n* *Stratégies de montée en charge*: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\nh3. Other related resources\n* *Mesures et analyses de l'API*: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n\nh2. 4. Conception d’API\n\nCréer des architectures d'API cohérentes, réutilisables et fondées sur les objectifs métier et des normes communes.\n\nh3. Canvas questions\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n* *Interactions CRUD*: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n* *Modèles d'entrée et de sortie CRUD*: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n* *Traitement et validation CRUD*: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n* *Interactions pilotées par requêtes*: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n* *Modèles d'entrée et de sortie pilotés par les requêtes*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n* *Traitement et validation pilotés par les requêtes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n* *Interactions pilotées par commandes*: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par commande*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n* *Traitement et validation pilotés par les commandes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n* *Interactions pilotées par les événements*: Quels événements doivent être publiés ou consommés, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par les événements*: Modèles d'entrée et de sortie pilotés par les événements\n* *Traitement et validation pilotés par les événements*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\nh4. REST Canvas\nComment concevoir l’API selon les principes RESTful ?\n* *Ressources API*: Quelles sont les ressources clés exposées par l’API?\n* *Modèle de ressource API*: Quelle est la structure du modèle de ressources de l’API?\n* *Verbes API*: Quels verbes HTTP sont utilisés pour interagir avec les ressources de l’API?\n* *Exemple de verbe API*: Fournissez un exemple de requête et de réponse API pour chaque verbe.\n\nh4. Event Canvas\nQuels événements sont pertinents pour la capacité ou l’interface, et comment sont-ils traités ?\n* *Tâche utilisateur / Déclencheur*: Quelle action utilisateur ou événement système déclenche cette opération d'événement?\n* *Entrée / Charge utile de l'événement*: Quelles données sont incluses dans la charge utile de l'événement entrant? Spécifiez les attributs clés.\n* *Traitement / Logique*: Décrivez la logique de traitement systèmes backend, y compris les validations, transformations ou décisions de routage.\n* *Sortie / Résultat de l'événement*: Quel événement ou accusé de réception est produit? Incluez les attributs de la charge utile de sortie.\n\nh4. GraphQL Canvas\nComment concevoir l’API selon les principes GraphQL ?\n* *Nom de l’API*: Quel est le nom de l’API GraphQL ou du point de terminaison ?\n* *Objectifs des utilisateurs*: Quels problèmes les utilisateurs de l’API cherchent-ils à résoudre ? Quelles données leur sont nécessaires ?\n* *Types clés*: Quels sont les types principaux exposés (ex. Utilisateur, Commande, Produit) ?\n* *Relations*: Comment les types sont-ils liés dans les requêtes imbriquées ?\n* *Requêtes*: Quelles requêtes courantes doivent être prises en charge ?\n* *Mutations*: Quelles opérations vont modifier les données (ex. créer, mettre à jour, supprimer) ?\n* *Abonnements*: Existe-t-il des mises à jour en temps réel ou des événements auxquels les utilisateurs peuvent s'abonner ?\n* *Règles d'autorisation*: Qui peut accéder à quels champs ou types ?\n* *Contraintes des utilisateurs*: Y a-t-il des contraintes de pagination, de filtrage ou de limitation du débit ?\n* *Notes / Questions ouvertes*: Y a-t-il des décisions en attente ou des considérations d’intégration ?\n\nh3. Other related resources\n* *Principes de conception de l'API*: Un guide concis sur l'ergonomie, la facilité de découverte et la cohérence des API, fondé sur des règles de conception communes et les besoins réels des consommateurs.\n* *Contrat de première conception*: Une ligne directrice qui préconise des approches \"API-first\" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.\n\nh2. 5. Livraison d’API\n\nConstruire, tester et publier des API en utilisant des pipelines de livraison modernes et les meilleures pratiques d'ingénierie.\n\nh3. Station questions\n* Utilisez les meilleures pratiques de développement d'API comme guide pour mettre en œuvre le contrat d'interface validé à l'aide de frameworks et de bibliothèques établis, en veillant à ce que le résultat soit réutilisable et maintenable.\n* Construisez l'implémentation de l'API à partir du contrat d'interface validé en utilisant des frameworks, des bibliothèques et des standards d'équipe établis.\n* Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n* Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n* S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n* Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n* Fournir des frameworks de développement, des bibliothèques et des normes pour la mise en œuvre des API. Mettre en œuvre des pipelines CI/CD, des cadres d'assurance qualité et des outils d'automatisation du déploiement.\n* Même les meilleures conceptions d'API échouent si la livraison est incohérente. Cette station garantit que vos API sont construites avec qualité, testées de manière approfondie et déployées de manière fiable, ce qui permet des itérations plus rapides et une plus grande confiance.\n\nh3. Other related resources\n* *Meilleures pratiques en matière de développement d'API*: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.\n* *Meilleures pratiques de test de l'API*: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.\n* *APIOps CI/CD pour les API*: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n* *Meilleures pratiques en matière de sécurité des API*: Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.\n\nh2. 6. Audit API\n\nVérifiez que les API répondent aux normes métier, de conception et opérationnelles avant leur publication et leur mise à disposition.\n\nh3. Station questions\n* Mener des audits pour s'assurer que les API respectent les normes organisationnelles, techniques et juridiques avant d'être publiées.\n* Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n* Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n* Mettez en place un processus d'audit cohérent qui évalue l'état de préparation des API à toutes les étapes du cycle de vie à l'aide de critères, de preuves et de normes définis. Assurez-vous que les lacunes sont identifiées tôt et résolues avant la publication.\n* Les API sont des produits à longue durée de vie et doivent répondre aux attentes en matière de qualité, de cohérence et de conformité. L'audit relie les décisions de conception, la mise en œuvre et l'état de préparation opérationnelle à des normes définies, réduisant ainsi les risques avant la mise à disposition.\n\nh3. Other related resources\n* *Liste de contrôle de l'audit de l'API*: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n* *Meilleures pratiques en matière de conformité de l'API*: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\nh2. 7. Publication d’API\n\nExposer les API de manière sûre et claire au bon public avec la bonne documentation et les bons processus.\n\nh3. Station questions\n* Publier les API dans les passerelles et les environnements appropriés afin de favoriser la réutilisation pour de multiples utilisateurs.\n* Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n* Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n* Permettre aux API d'être publiées dans l'environnement approprié et disposer de mécanismes d'enregistrement et d'accès clairs (par exemple, clés API, OAuth, plans d'abonnement) en fonction des segments de utilisateurs et des exigences en matière de sécurité et de conformité.\n* La publication va plus loin que le déploiement - il s'agit de la découvrabilité, de l'accès et de l'assistance. Si les API ne sont pas publiées correctement, elles ne seront pas utilisées, réutilisées ou sécurisées efficacement.\n\nh3. Other related resources\n* *APIOps CI/CD pour les API*: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n* *Meilleures pratiques en matière d'intégration de l'API*: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n* *Liste de contrôle de l'audit de l'API*: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n\nh2. 8. Suivi & amelioration API\n\nUtiliser les mesures et le retour d'information pour suivre les performances de l'API et favoriser l'amélioration continue.\n\nh3. Station questions\n* Contrôler les indicateurs de performance (par exemple, les appels à l'API, la latence, les taux d'erreur) et les indicateurs d'adoption (par exemple, NPS).\n* Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n* Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n* Mettre en place des cadres d'analyse pour suivre les performances et l'engagement. Développer des boucles de rétroaction, des outils d'analyse et des stratégies d'engagement pour les API.\n* La livraison d'API ne s'arrête pas au lancement. Sans surveillance, les équipes ne peuvent pas améliorer l'adoption, les performances ou le retour sur investissement. Cette station garantit que les API restent utiles, sécurisées et qu'elles évoluent avec les besoins de l'entreprise.\n\nh3. Other related resources\n* *Mesures et analyses de l'API*: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n* *Stratégies d'engagement de la communauté de l'API*: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social." }, { "id": "integration-productization-cycle:question-template-markdown", "cycleId": "integration-productization-cycle", "kind": "questions", "format": "markdown", "title": "Cycle de productisation des capacités d’intégration question template Markdown", "body": "# Cycle de productisation des capacités d’intégration question template\n\nCycle pour productiser des capacites d integration reutilisables avant de choisir le mode de mise en oeuvre.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\n## 1. Stratégie de capacité d’intégration\n\nCadrer la capacite d integration reutilisable, le besoin metier, la responsabilite et la reutilisation attendue avant de choisir le mode de mise en oeuvre.\n\n### Canvas questions\n#### Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n- **Persona**: Qui est le client type qui vit ce parcours?\n- **Le client découvre le besoin**: Comment le client reconnaît-il son besoin ou son problème?\n- **Le besoin du client est résolu**: Comment le besoin du client est-il finalement résolu?\n- **Étapes du parcours**: Quelles sont les étapes suivies par le client dans son parcours?\n- **Douleurs**: Quels sont les irritants ou défis du client?\n- **Gains**: Quels sont les gains ou bénéfices pour le client?\n- **Entrées et sorties**: Quelles sont les entrées et les sorties à chaque étape?\n- **Règles d'interaction et de traitement**: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Capability Value Proposition Canvas\nQuelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?\n- **Tâches et résultats des utilisateurs**: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?\n- **Fonctionnalités de capacité génératrices de gains**: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?\n- **Fonctionnalités de capacité qui réduisent les irritants**: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?\n- **Capacités réutilisables**: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?\n\n#### Capability Business Model Canvas\nDans quelle mesure cette capacité d’intégration doit-elle être viable, réutilisable, financée, possédée, accompagnée et découvrable ?\n- **Proposition de valeur de la capacité**: Quelle valeur cette capacité réutilisable apporte-t-elle aux utilisateurs et à l’organisation ou à l’écosystème ?\n- **Segments d’utilisateurs de la capacité**: Qui sont les utilisateurs actuels et potentiels de la capacité, y compris équipes, partenaires, systèmes, produits ou utilisateurs de données ?\n- **Engagement des utilisateurs**: Comment les utilisateurs découvriront-ils, évalueront-ils, demanderont-ils, onboarderont-ils, obtiendront-ils du support et donneront-ils du feedback sur la capacité ?\n- **Canaux**: Par quels catalogues, portails, marketplaces, sites de documentation, parcours de support ou processus de gouvernance les utilisateurs interagiront-ils avec la capacité ?\n- **Ressources clés**: Quels systèmes, actifs de données, plateformes, personnes, standards, financements et capacités opérationnelles sont nécessaires ?\n- **Activités clés**: Que doivent faire le responsable de la capacité et les producteurs pour concevoir, mettre à disposition, gouverner, accompagner et améliorer la capacité ?\n- **Partenaires clés**: Quels partenaires métier, technologie, données, sécurité, juridique, plateforme ou externes sont nécessaires pour faire fonctionner la capacité ?\n- **Bénéfices**: Quels bénéfices métier, opérationnels, écosystémiques, de réutilisation, de conformité ou de coût justifient la capacité ?\n- **Coûts**: Quels sont les coûts significatifs de construction, d’exploitation, de gouvernance, de support et d’évolution de la capacité ?\n\n## 2. Exigences des utilisateurs d’intégration & onboarding\n\nCapturez les utilisateurs d’intégration, les responsabilités des fournisseurs, les besoins d’onboarding, les attentes de service et les contraintes opérationnelles.\n\n### Canvas questions\n#### Consumer Experience Requirements Canvas\nQuelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?\n- **Objectifs des utilisateurs**: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?\n- **Disponibilité et fraîcheur**: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?\n- **Volume et performance**: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?\n- **Qualité et cohérence des données**: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?\n- **Sécurité, protection des données et conformité**: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?\n- **Onboarding et accès**: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?\n- **Changement et versionnement**: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?\n- **Observabilité et support**: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?\n- **Reprise et continuité**: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?\n- **Implications d’architecture**: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?\n\n### Other related resources\n- **Meilleures pratiques en matière d'intégration de l'API**: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n\n## 3. Architecture d integration & decisions de plateforme\n\nChoisir l architecture d integration, le mode de mise en oeuvre et les capacites de plateforme en tenant compte des contraintes et du modele de gouvernance.\n\n### Canvas questions\n#### Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n- **Risques de disponibilité**: Quels sont les risques potentiels pour la disponibilité de l’API?\n- **Atténuer les risques de disponibilité**: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n- **Risques de sécurité**: Quels sont les risques de sécurité potentiels associés à l’API?\n- **Atténuer les risques de sécurité**: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n- **Risques liés aux données**: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n- **Atténuer les risques liés aux données**: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\n#### Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n- **Groupes de localisation / de confiance**: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n- **Caractéristiques des groupes**: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n- **Emplacements / Zones pertinents**: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n- **Caractéristiques des emplacements / zones**: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n- **Distances réseau / réglementaires**: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n- **Caractéristiques des distance**: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n- **Points de terminaison de connectivité**: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n- **Caractéristiques d'accès aux points de terminaison**: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\n#### Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n- **Volumes d'activité actuels**: Quels sont les volumes d'affaires et taux de transaction actuels?\n- **Tendances de consommation futures**: Quelles sont les tendances de consommation anticipées?\n- **Exigences de charge maximale et de disponibilité**: Quelles sont les exigences de charge maximale et de disponibilité?\n- **Stratégies de mise en cache**: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n- **Stratégies de limitation de débit**: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n- **Stratégies de montée en charge**: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\n### Other related resources\n- **Lignes directrices pour l'intégration des partenaires**: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.\n\n## 4. Conception de solution d’intégration\n\nConcevoir le contrat d interface, les schemas, les payloads et les modeles d interaction pour le style d integration choisi.\n\n### Canvas questions\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n- **Interactions CRUD**: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n- **Modèles d'entrée et de sortie CRUD**: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n- **Traitement et validation CRUD**: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n- **Interactions pilotées par requêtes**: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n- **Modèles d'entrée et de sortie pilotés par les requêtes**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n- **Traitement et validation pilotés par les requêtes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n- **Interactions pilotées par commandes**: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par commande**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n- **Traitement et validation pilotés par les commandes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n- **Interactions pilotées par les événements**: Quels événements doivent être publiés ou consommés, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par les événements**: Modèles d'entrée et de sortie pilotés par les événements\n- **Traitement et validation pilotés par les événements**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\n#### REST Canvas\nComment concevoir l’API selon les principes RESTful ?\n- **Ressources API**: Quelles sont les ressources clés exposées par l’API?\n- **Modèle de ressource API**: Quelle est la structure du modèle de ressources de l’API?\n- **Verbes API**: Quels verbes HTTP sont utilisés pour interagir avec les ressources de l’API?\n- **Exemple de verbe API**: Fournissez un exemple de requête et de réponse API pour chaque verbe.\n\n#### Event Canvas\nQuels événements sont pertinents pour la capacité ou l’interface, et comment sont-ils traités ?\n- **Tâche utilisateur / Déclencheur**: Quelle action utilisateur ou événement système déclenche cette opération d'événement?\n- **Entrée / Charge utile de l'événement**: Quelles données sont incluses dans la charge utile de l'événement entrant? Spécifiez les attributs clés.\n- **Traitement / Logique**: Décrivez la logique de traitement systèmes backend, y compris les validations, transformations ou décisions de routage.\n- **Sortie / Résultat de l'événement**: Quel événement ou accusé de réception est produit? Incluez les attributs de la charge utile de sortie.\n\n#### GraphQL Canvas\nComment concevoir l’API selon les principes GraphQL ?\n- **Nom de l’API**: Quel est le nom de l’API GraphQL ou du point de terminaison ?\n- **Objectifs des utilisateurs**: Quels problèmes les utilisateurs de l’API cherchent-ils à résoudre ? Quelles données leur sont nécessaires ?\n- **Types clés**: Quels sont les types principaux exposés (ex. Utilisateur, Commande, Produit) ?\n- **Relations**: Comment les types sont-ils liés dans les requêtes imbriquées ?\n- **Requêtes**: Quelles requêtes courantes doivent être prises en charge ?\n- **Mutations**: Quelles opérations vont modifier les données (ex. créer, mettre à jour, supprimer) ?\n- **Abonnements**: Existe-t-il des mises à jour en temps réel ou des événements auxquels les utilisateurs peuvent s'abonner ?\n- **Règles d'autorisation**: Qui peut accéder à quels champs ou types ?\n- **Contraintes des utilisateurs**: Y a-t-il des contraintes de pagination, de filtrage ou de limitation du débit ?\n- **Notes / Questions ouvertes**: Y a-t-il des décisions en attente ou des considérations d’intégration ?\n\n### Other related resources\n- **Guide de sélection du mode d’intégration**: Guide pour choisir entre API, événement, fichier, flux, produit de données, intégration directe ou mode hybride selon les exigences et contraintes.\n- **Contrat de première conception**: Une ligne directrice qui préconise des approches \"API-first\" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.\n\n## 5. Livraison & opérations d’intégration\n\nConstruire, tester, automatiser, deployer et exploiter la capacite d integration avec le mode de mise en oeuvre choisi et le contrat d interface valide.\n\n### Station questions\n- Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.\n- Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.\n- Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n- Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n- S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n- Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n- Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.\n- Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.\n\n### Other related resources\n- **Meilleures pratiques en matière de développement d'API**: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.\n- **Meilleures pratiques de test de l'API**: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.\n- **APIOps CI/CD pour les API**: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n- **Meilleures pratiques en matière de sécurité des API**: Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.\n- **Lignes directrices pour l'intégration des partenaires**: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.\n\n## 6. Assurance qualité des intégrations\n\nAssurez la préparation, la gouvernance, la qualité, la sécurité, la conformité et les preuves opérationnelles de l’intégration avant publication.\n\n### Station questions\n- Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.\n- Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n- Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n- Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.\n- Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.\n\n### Other related resources\n- **Liste de contrôle de l'audit de l'API**: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n- **Meilleures pratiques en matière de conformité de l'API**: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\n## 7. Publication & enablement de l integration\n\nPublier la capacite d integration afin que les equipes puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, la reutiliser et obtenir du support.\n\n### Station questions\n- Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.\n- Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n- Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n- Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.\n- Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.\n\n### Other related resources\n- **Meilleures pratiques en matière d'intégration de l'API**: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n- **Modèle de contrat de service**: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.\n\n## 8. Suivi & amélioration des intégrations\n\nSuivez la fiabilité, la réutilisation, les incidents, la performance, les résultats utilisateurs et les besoins d’amélioration de l’intégration.\n\n### Station questions\n- Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.\n- Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n- Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n- Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.\n- Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.\n\n### Other related resources\n- **Mesures et analyses de l'API**: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n- **Stratégies d'engagement de la communauté de l'API**: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social." }, { "id": "integration-productization-cycle:question-template-confluence-wiki", "cycleId": "integration-productization-cycle", "kind": "questions", "format": "confluence-wiki", "title": "Cycle de productisation des capacités d’intégration question template Confluence wiki", "body": "h1. Cycle de productisation des capacités d’intégration question template\n\nCycle pour productiser des capacites d integration reutilisables avant de choisir le mode de mise en oeuvre.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\nh2. 1. Stratégie de capacité d’intégration\n\nCadrer la capacite d integration reutilisable, le besoin metier, la responsabilite et la reutilisation attendue avant de choisir le mode de mise en oeuvre.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n* *Persona*: Qui est le client type qui vit ce parcours?\n* *Le client découvre le besoin*: Comment le client reconnaît-il son besoin ou son problème?\n* *Le besoin du client est résolu*: Comment le besoin du client est-il finalement résolu?\n* *Étapes du parcours*: Quelles sont les étapes suivies par le client dans son parcours?\n* *Douleurs*: Quels sont les irritants ou défis du client?\n* *Gains*: Quels sont les gains ou bénéfices pour le client?\n* *Entrées et sorties*: Quelles sont les entrées et les sorties à chaque étape?\n* *Règles d'interaction et de traitement*: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Capability Value Proposition Canvas\nQuelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?\n* *Tâches et résultats des utilisateurs*: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?\n* *Fonctionnalités de capacité génératrices de gains*: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?\n* *Fonctionnalités de capacité qui réduisent les irritants*: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?\n* *Capacités réutilisables*: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?\n\nh4. Capability Business Model Canvas\nDans quelle mesure cette capacité d’intégration doit-elle être viable, réutilisable, financée, possédée, accompagnée et découvrable ?\n* *Proposition de valeur de la capacité*: Quelle valeur cette capacité réutilisable apporte-t-elle aux utilisateurs et à l’organisation ou à l’écosystème ?\n* *Segments d’utilisateurs de la capacité*: Qui sont les utilisateurs actuels et potentiels de la capacité, y compris équipes, partenaires, systèmes, produits ou utilisateurs de données ?\n* *Engagement des utilisateurs*: Comment les utilisateurs découvriront-ils, évalueront-ils, demanderont-ils, onboarderont-ils, obtiendront-ils du support et donneront-ils du feedback sur la capacité ?\n* *Canaux*: Par quels catalogues, portails, marketplaces, sites de documentation, parcours de support ou processus de gouvernance les utilisateurs interagiront-ils avec la capacité ?\n* *Ressources clés*: Quels systèmes, actifs de données, plateformes, personnes, standards, financements et capacités opérationnelles sont nécessaires ?\n* *Activités clés*: Que doivent faire le responsable de la capacité et les producteurs pour concevoir, mettre à disposition, gouverner, accompagner et améliorer la capacité ?\n* *Partenaires clés*: Quels partenaires métier, technologie, données, sécurité, juridique, plateforme ou externes sont nécessaires pour faire fonctionner la capacité ?\n* *Bénéfices*: Quels bénéfices métier, opérationnels, écosystémiques, de réutilisation, de conformité ou de coût justifient la capacité ?\n* *Coûts*: Quels sont les coûts significatifs de construction, d’exploitation, de gouvernance, de support et d’évolution de la capacité ?\n\nh2. 2. Exigences des utilisateurs d’intégration & onboarding\n\nCapturez les utilisateurs d’intégration, les responsabilités des fournisseurs, les besoins d’onboarding, les attentes de service et les contraintes opérationnelles.\n\nh3. Canvas questions\nh4. Consumer Experience Requirements Canvas\nQuelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?\n* *Objectifs des utilisateurs*: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?\n* *Disponibilité et fraîcheur*: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?\n* *Volume et performance*: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?\n* *Qualité et cohérence des données*: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?\n* *Sécurité, protection des données et conformité*: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?\n* *Onboarding et accès*: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?\n* *Changement et versionnement*: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?\n* *Observabilité et support*: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?\n* *Reprise et continuité*: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?\n* *Implications d’architecture*: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?\n\nh3. Other related resources\n* *Meilleures pratiques en matière d'intégration de l'API*: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n\nh2. 3. Architecture d integration & decisions de plateforme\n\nChoisir l architecture d integration, le mode de mise en oeuvre et les capacites de plateforme en tenant compte des contraintes et du modele de gouvernance.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n* *Risques de disponibilité*: Quels sont les risques potentiels pour la disponibilité de l’API?\n* *Atténuer les risques de disponibilité*: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n* *Risques de sécurité*: Quels sont les risques de sécurité potentiels associés à l’API?\n* *Atténuer les risques de sécurité*: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n* *Risques liés aux données*: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n* *Atténuer les risques liés aux données*: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\nh4. Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n* *Groupes de localisation / de confiance*: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n* *Caractéristiques des groupes*: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n* *Emplacements / Zones pertinents*: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n* *Caractéristiques des emplacements / zones*: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n* *Distances réseau / réglementaires*: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n* *Caractéristiques des distance*: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n* *Points de terminaison de connectivité*: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n* *Caractéristiques d'accès aux points de terminaison*: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\nh4. Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n* *Volumes d'activité actuels*: Quels sont les volumes d'affaires et taux de transaction actuels?\n* *Tendances de consommation futures*: Quelles sont les tendances de consommation anticipées?\n* *Exigences de charge maximale et de disponibilité*: Quelles sont les exigences de charge maximale et de disponibilité?\n* *Stratégies de mise en cache*: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n* *Stratégies de limitation de débit*: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n* *Stratégies de montée en charge*: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\nh3. Other related resources\n* *Lignes directrices pour l'intégration des partenaires*: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.\n\nh2. 4. Conception de solution d’intégration\n\nConcevoir le contrat d interface, les schemas, les payloads et les modeles d interaction pour le style d integration choisi.\n\nh3. Canvas questions\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n* *Interactions CRUD*: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n* *Modèles d'entrée et de sortie CRUD*: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n* *Traitement et validation CRUD*: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n* *Interactions pilotées par requêtes*: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n* *Modèles d'entrée et de sortie pilotés par les requêtes*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n* *Traitement et validation pilotés par les requêtes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n* *Interactions pilotées par commandes*: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par commande*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n* *Traitement et validation pilotés par les commandes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n* *Interactions pilotées par les événements*: Quels événements doivent être publiés ou consommés, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par les événements*: Modèles d'entrée et de sortie pilotés par les événements\n* *Traitement et validation pilotés par les événements*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\nh4. REST Canvas\nComment concevoir l’API selon les principes RESTful ?\n* *Ressources API*: Quelles sont les ressources clés exposées par l’API?\n* *Modèle de ressource API*: Quelle est la structure du modèle de ressources de l’API?\n* *Verbes API*: Quels verbes HTTP sont utilisés pour interagir avec les ressources de l’API?\n* *Exemple de verbe API*: Fournissez un exemple de requête et de réponse API pour chaque verbe.\n\nh4. Event Canvas\nQuels événements sont pertinents pour la capacité ou l’interface, et comment sont-ils traités ?\n* *Tâche utilisateur / Déclencheur*: Quelle action utilisateur ou événement système déclenche cette opération d'événement?\n* *Entrée / Charge utile de l'événement*: Quelles données sont incluses dans la charge utile de l'événement entrant? Spécifiez les attributs clés.\n* *Traitement / Logique*: Décrivez la logique de traitement systèmes backend, y compris les validations, transformations ou décisions de routage.\n* *Sortie / Résultat de l'événement*: Quel événement ou accusé de réception est produit? Incluez les attributs de la charge utile de sortie.\n\nh4. GraphQL Canvas\nComment concevoir l’API selon les principes GraphQL ?\n* *Nom de l’API*: Quel est le nom de l’API GraphQL ou du point de terminaison ?\n* *Objectifs des utilisateurs*: Quels problèmes les utilisateurs de l’API cherchent-ils à résoudre ? Quelles données leur sont nécessaires ?\n* *Types clés*: Quels sont les types principaux exposés (ex. Utilisateur, Commande, Produit) ?\n* *Relations*: Comment les types sont-ils liés dans les requêtes imbriquées ?\n* *Requêtes*: Quelles requêtes courantes doivent être prises en charge ?\n* *Mutations*: Quelles opérations vont modifier les données (ex. créer, mettre à jour, supprimer) ?\n* *Abonnements*: Existe-t-il des mises à jour en temps réel ou des événements auxquels les utilisateurs peuvent s'abonner ?\n* *Règles d'autorisation*: Qui peut accéder à quels champs ou types ?\n* *Contraintes des utilisateurs*: Y a-t-il des contraintes de pagination, de filtrage ou de limitation du débit ?\n* *Notes / Questions ouvertes*: Y a-t-il des décisions en attente ou des considérations d’intégration ?\n\nh3. Other related resources\n* *Guide de sélection du mode d’intégration*: Guide pour choisir entre API, événement, fichier, flux, produit de données, intégration directe ou mode hybride selon les exigences et contraintes.\n* *Contrat de première conception*: Une ligne directrice qui préconise des approches \"API-first\" utilisant des contrats formels (par exemple, OpenAPI) pour aligner les parties prenantes avant le développement.\n\nh2. 5. Livraison & opérations d’intégration\n\nConstruire, tester, automatiser, deployer et exploiter la capacite d integration avec le mode de mise en oeuvre choisi et le contrat d interface valide.\n\nh3. Station questions\n* Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.\n* Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.\n* Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n* Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n* S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n* Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n* Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.\n* Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.\n\nh3. Other related resources\n* *Meilleures pratiques en matière de développement d'API*: Guide de mise en œuvre pour transformer un contrat d’interface API validé en une base de code API cohérente et maintenable, à l’aide de bibliothèques standard, de modèles réutilisables et de workflows de développement harmonisés.\n* *Meilleures pratiques de test de l'API*: Lignes directrices pour la mise en œuvre de tests fonctionnels, de performance et de sécurité automatisés tout au long du cycle de vie de l'API.\n* *APIOps CI/CD pour les API*: Des conseils de déploiement qui intègrent les tâches du cycle de vie de l'API - conception, test, gouvernance - dans les pipelines d'intégration et de livraison en continu.\n* *Meilleures pratiques en matière de sécurité des API*: Un ensemble de contrôles exploitables pour sécuriser les API, y compris l'authentification, l'autorisation, le cryptage, la limitation du débit et les contrôles de conformité au niveau du pipeline.\n* *Lignes directrices pour l'intégration des partenaires*: Listes de contrôle de l'intégration et modèles de communication pour gérer les aspects techniques et juridiques des relations avec des API tierces.\n\nh2. 6. Assurance qualité des intégrations\n\nAssurez la préparation, la gouvernance, la qualité, la sécurité, la conformité et les preuves opérationnelles de l’intégration avant publication.\n\nh3. Station questions\n* Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.\n* Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n* Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n* Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.\n* Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.\n\nh3. Other related resources\n* *Liste de contrôle de l'audit de l'API*: Une liste de contrôle basée sur le cycle de vie permettant de vérifier l'état de préparation de l'API à travers les phases de conception, de livraison, de publication et de conformité à l'aide de critères d'audit et de preuves définis.\n* *Meilleures pratiques en matière de conformité de l'API*: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\nh2. 7. Publication & enablement de l integration\n\nPublier la capacite d integration afin que les equipes puissent la decouvrir, l evaluer, demander l acces, terminer l onboarding, la reutiliser et obtenir du support.\n\nh3. Station questions\n* Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.\n* Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n* Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n* Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.\n* Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.\n\nh3. Other related resources\n* *Meilleures pratiques en matière d'intégration de l'API*: Meilleures pratiques pour rationaliser les parcours d'accueil des consommateurs d'API avec une inscription étape par étape, une découverte et des conseils pour le premier appel.\n* *Modèle de contrat de service*: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.\n\nh2. 8. Suivi & amélioration des intégrations\n\nSuivez la fiabilité, la réutilisation, les incidents, la performance, les résultats utilisateurs et les besoins d’amélioration de l’intégration.\n\nh3. Station questions\n* Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.\n* Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n* Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n* Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.\n* Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.\n\nh3. Other related resources\n* *Mesures et analyses de l'API*: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise.\n* *Stratégies d'engagement de la communauté de l'API*: Un guide pour favoriser l'adoption des API en cultivant des communautés grâce à des contenus, des canaux d'assistance, des boucles de retour d'information et des stratégies d'engagement social." }, { "id": "automation-cycle:question-template-markdown", "cycleId": "automation-cycle", "kind": "questions", "format": "markdown", "title": "Cycle d’automatisation question template Markdown", "body": "# Cycle d’automatisation question template\n\nCycle pour identifier, concevoir, livrer, enable et améliorer des opportunités d’automatisation.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\n## 1. Stratégie d’opportunité d’automatisation\n\nIdentifiez et priorisez les opportunités d’automatisation selon la valeur, la faisabilité, le risque, la responsabilité et l’impact attendu sur le processus.\n\n### Canvas questions\n#### Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n- **Persona**: Qui est le client type qui vit ce parcours?\n- **Le client découvre le besoin**: Comment le client reconnaît-il son besoin ou son problème?\n- **Le besoin du client est résolu**: Comment le besoin du client est-il finalement résolu?\n- **Étapes du parcours**: Quelles sont les étapes suivies par le client dans son parcours?\n- **Douleurs**: Quels sont les irritants ou défis du client?\n- **Gains**: Quels sont les gains ou bénéfices pour le client?\n- **Entrées et sorties**: Quelles sont les entrées et les sorties à chaque étape?\n- **Règles d'interaction et de traitement**: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Capability Value Proposition Canvas\nQuelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?\n- **Tâches et résultats des utilisateurs**: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?\n- **Fonctionnalités de capacité génératrices de gains**: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?\n- **Fonctionnalités de capacité qui réduisent les irritants**: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?\n- **Capacités réutilisables**: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?\n\n## 2. Exigences processus & utilisateur\n\nCapturez les utilisateurs du processus, les rôles, les transferts, les exceptions, les contraintes et les attentes de service avant de concevoir l’automatisation.\n\n### Canvas questions\n#### Consumer Experience Requirements Canvas\nQuelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?\n- **Objectifs des utilisateurs**: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?\n- **Disponibilité et fraîcheur**: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?\n- **Volume et performance**: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?\n- **Qualité et cohérence des données**: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?\n- **Sécurité, protection des données et conformité**: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?\n- **Onboarding et accès**: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?\n- **Changement et versionnement**: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?\n- **Observabilité et support**: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?\n- **Reprise et continuité**: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?\n- **Implications d’architecture**: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?\n\n## 3. Décision de plateforme d’automatisation\n\nChoisir la plateforme d automatisation, le runtime, l approche d integration, les controles de gouvernance et les contraintes operationnelles.\n\n### Canvas questions\n#### Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n- **Risques de disponibilité**: Quels sont les risques potentiels pour la disponibilité de l’API?\n- **Atténuer les risques de disponibilité**: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n- **Risques de sécurité**: Quels sont les risques de sécurité potentiels associés à l’API?\n- **Atténuer les risques de sécurité**: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n- **Risques liés aux données**: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n- **Atténuer les risques liés aux données**: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\n#### Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n- **Groupes de localisation / de confiance**: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n- **Caractéristiques des groupes**: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n- **Emplacements / Zones pertinents**: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n- **Caractéristiques des emplacements / zones**: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n- **Distances réseau / réglementaires**: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n- **Caractéristiques des distance**: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n- **Points de terminaison de connectivité**: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n- **Caractéristiques d'accès aux points de terminaison**: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\n#### Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n- **Volumes d'activité actuels**: Quels sont les volumes d'affaires et taux de transaction actuels?\n- **Tendances de consommation futures**: Quelles sont les tendances de consommation anticipées?\n- **Exigences de charge maximale et de disponibilité**: Quelles sont les exigences de charge maximale et de disponibilité?\n- **Stratégies de mise en cache**: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n- **Stratégies de limitation de débit**: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n- **Stratégies de montée en charge**: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\n### Other related resources\n- **Guide de responsabilité opérationnelle**: Guide pour définir responsabilité, runbooks, supervision, support, suivi, contrôle des changements et amélioration continue.\n\n## 4. Conception de workflow d’automatisation\n\nConcevoir le workflow d automatisation, les declencheurs, les points de decision, les integrations, le traitement des donnees, les contrats d interface pertinents et les chemins d exception.\n\n### Canvas questions\n#### Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n- **Étapes du parcours client sélectionnées**: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n- **Entités principales et signification métier**: Quelles sont les entités principales et leur signification métier?\n- **Attributs et importance métier**: Quels sont les attributs clés de chaque entité et leur importance métier?\n- **Relations entre les entités**: Quelles sont les relations entre les entités?\n- **Règles métier, conformité et intégrité**: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n- **Considérations de sécurité et de confidentialité**: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\n#### Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n- **Interactions CRUD**: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n- **Modèles d'entrée et de sortie CRUD**: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n- **Traitement et validation CRUD**: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n- **Interactions pilotées par requêtes**: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n- **Modèles d'entrée et de sortie pilotés par les requêtes**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n- **Traitement et validation pilotés par les requêtes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n- **Interactions pilotées par commandes**: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par commande**: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n- **Traitement et validation pilotés par les commandes**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n- **Interactions pilotées par les événements**: Quels événements doivent être publiés ou consommés, le cas échéant ?\n- **Modèles d'entrée et de sortie pilotés par les événements**: Modèles d'entrée et de sortie pilotés par les événements\n- **Traitement et validation pilotés par les événements**: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\n### Other related resources\n- **Guide de conception des processus et workflows**: Guide pour modéliser étapes, rôles, transferts, décisions, états, entrées, sorties et exceptions d’un workflow automatisé.\n- **Guide des décisions et règles métier**: Guide pour capturer règles, seuils, décisions, validations, critères d’éligibilité et responsabilités.\n- **Guide des déclencheurs, transferts et exceptions**: Guide pour définir déclencheurs, transferts humains, exceptions, reprises, actions compensatoires et escalades.\n\n## 5. Livraison & operations de l automatisation\n\nConstruisez, testez, déployez, documentez et exploitez l’automatisation avec une responsabilité et des chemins de rollback clairs.\n\n### Station questions\n- Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.\n- Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.\n- Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n- Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n- S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n- Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n- Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.\n- Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.\n\n### Other related resources\n- **Guide de test des automatisations**: Guide pour tester workflows, décisions, intégrations, exceptions, rollback, supervision et impact utilisateur.\n- **Guide de responsabilité opérationnelle**: Guide pour définir responsabilité, runbooks, supervision, support, suivi, contrôle des changements et amélioration continue.\n- **Guide de rollback et supervision**: Guide pour concevoir rollback, pause, dérogation manuelle, suivi, supervision et reprise.\n\n## 6. Revue de préparation de l’automatisation\n\nRevoyez la préparation, la qualité, les risques, la conformité, la supervision humaine, les preuves et les critères de publication de l’automatisation.\n\n### Station questions\n- Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.\n- Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n- Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n- Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.\n- Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.\n\n### Other related resources\n- **Checklist de préparation des automatisations**: Checklist pour valider workflow, contrôles, risques, conformité, supervision humaine, preuves de test, rollback, opérations et préparation.\n- **Meilleures pratiques en matière de conformité de l'API**: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\n## 7. Deploiement & enablement de l automatisation\n\nEnablez les utilisateurs et opérateurs avec découverte, onboarding, instructions d’exploitation, chemins de support et communication de changement.\n\n### Station questions\n- Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.\n- Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n- Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n- Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.\n- Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.\n\n### Other related resources\n- **Guide de déploiement et d’enablement**: Guide pour déployer les automatisations avec communication, onboarding, instructions d’exploitation, support, conduite du changement et feedback.\n- **Modèle de contrat de service**: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.\n\n## 8. Suivi & amélioration de l’automatisation\n\nSuivez la performance de l’automatisation, les exceptions, la fiabilité, les résultats utilisateurs, l’impact opérationnel et les opportunités d’amélioration.\n\n### Station questions\n- Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.\n- Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n- Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n- Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.\n- Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.\n\n### Other related resources\n- **Guide de responsabilité opérationnelle**: Guide pour définir responsabilité, runbooks, supervision, support, suivi, contrôle des changements et amélioration continue.\n- **Mesures et analyses de l'API**: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise." }, { "id": "automation-cycle:question-template-confluence-wiki", "cycleId": "automation-cycle", "kind": "questions", "format": "confluence-wiki", "title": "Cycle d’automatisation question template Confluence wiki", "body": "h1. Cycle d’automatisation question template\n\nCycle pour identifier, concevoir, livrer, enable et améliorer des opportunités d’automatisation.\n\nUse this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.\n\nh2. 1. Stratégie d’opportunité d’automatisation\n\nIdentifiez et priorisez les opportunités d’automatisation selon la valeur, la faisabilité, le risque, la responsabilité et l’impact attendu sur le processus.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nQuel parcours client ou partenaire crée le besoin de capacité ou d’interface ?\n* *Persona*: Qui est le client type qui vit ce parcours?\n* *Le client découvre le besoin*: Comment le client reconnaît-il son besoin ou son problème?\n* *Le besoin du client est résolu*: Comment le besoin du client est-il finalement résolu?\n* *Étapes du parcours*: Quelles sont les étapes suivies par le client dans son parcours?\n* *Douleurs*: Quels sont les irritants ou défis du client?\n* *Gains*: Quels sont les gains ou bénéfices pour le client?\n* *Entrées et sorties*: Quelles sont les entrées et les sorties à chaque étape?\n* *Règles d'interaction et de traitement*: Quelles sont les règles d'interaction et de traitement à chaque étape?\n\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Capability Value Proposition Canvas\nQuelle capacité réutilisable créerait de la valeur pour les utilisateurs sans décider encore si elle doit être mise à disposition sous forme d’API, d’événement, de fichier, de flux, de produit de données ou d’un autre mode de mise en œuvre ?\n* *Tâches et résultats des utilisateurs*: Que cherchent à accomplir les utilisateurs, partenaires, systèmes ou équipes ?\n* *Fonctionnalités de capacité génératrices de gains*: Quelles fonctionnalités de capacité aideraient les utilisateurs à obtenir de meilleurs résultats, plus de rapidité, d’automatisation, d’insights, de portée ou de conformité ?\n* *Fonctionnalités de capacité qui réduisent les irritants*: Quelles fonctionnalités de capacité supprimeraient les frictions, le travail manuel, les erreurs, les retards, les risques ou l’incertitude pour les utilisateurs ?\n* *Capacités réutilisables*: Quelles capacités métier ou données réutilisables pourraient répondre à ces tâches, gains et irritants pour plusieurs utilisateurs ou cas d’usage ?\n\nh2. 2. Exigences processus & utilisateur\n\nCapturez les utilisateurs du processus, les rôles, les transferts, les exceptions, les contraintes et les attentes de service avant de concevoir l’automatisation.\n\nh3. Canvas questions\nh4. Consumer Experience Requirements Canvas\nQuelles exigences d’expérience et non fonctionnelles les utilisateurs doivent-ils préciser avant de décider de la meilleure architecture d’intégration ?\n* *Objectifs des utilisateurs*: Quels sont les objectifs métier, de workflow, de décision, d’automatisation ou d’usage des données des utilisateurs ?\n* *Disponibilité et fraîcheur*: Quand la capacité doit-elle être disponible, quelle fraîcheur d’information est nécessaire et quelles fenêtres de latence ou de mise à disposition comptent ?\n* *Volume et performance*: Quels volumes de requêtes, événements, enregistrements, fichiers, lots, utilisateurs ou transactions la capacité doit-elle supporter aujourd’hui et demain ?\n* *Qualité et cohérence des données*: Quelles attentes les utilisateurs ont-ils en matière d’exactitude, complétude, cohérence, ordre, déduplication, rapprochement ou validation ?\n* *Sécurité, protection des données et conformité*: Quelles contraintes d’identité, d’autorisation, de confidentialité, de résidence, de consentement, de conservation, d’audit ou de réglementation s’appliquent ?\n* *Onboarding et accès*: Comment les utilisateurs doivent-ils trouver, demander, tester, obtenir l’approbation et commencer à utiliser la capacité ?\n* *Changement et versionnement*: Quelle tolérance au changement les utilisateurs ont-ils, et quelles attentes de préavis, compatibilité, migration ou versionnement s’appliquent ?\n* *Observabilité et support*: De quelle surveillance, information de statut, traçabilité, visibilité sur la qualité des données, support, propriété et communication d’incident les utilisateurs ont-ils besoin ?\n* *Reprise et continuité*: Quelles attentes de replay, retry, rapprochement, sauvegarde, fallback, continuité ou reprise manuelle doivent être prises en charge ?\n* *Implications d’architecture*: Que signifient ces exigences pour les styles d’architecture possibles, tels que API, événements, fichiers, flux, produits de données ou intégration directe ?\n\nh2. 3. Décision de plateforme d’automatisation\n\nChoisir la plateforme d automatisation, le runtime, l approche d integration, les controles de gouvernance et les contraintes operationnelles.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nQuels impacts métier une défaillance ou un mauvais comportement de la capacité ou de l’interface peut-il avoir ?\n* *Risques de disponibilité*: Quels sont les risques potentiels pour la disponibilité de l’API?\n* *Atténuer les risques de disponibilité*: Comment le fournisseur d’API peut-il atténuer les risques de disponibilité?\n* *Risques de sécurité*: Quels sont les risques de sécurité potentiels associés à l’API?\n* *Atténuer les risques de sécurité*: Comment le fournisseur d’API peut-il atténuer les risques de sécurité?\n* *Risques liés aux données*: Quels sont les risques potententiels pour l'intégrité ou la protection des données?\n* *Atténuer les risques liés aux données*: Comment le fournisseur d’API peut-il atténuer les risques liés aux données?\n\nh4. Location Canvas\nQuelles frontières géopolitiques, réglementaires, réseau et de confiance affectent cette capacité ou interface ?\n* *Groupes de localisation / de confiance*: Quels sont les groupes géopolitiques, réglementaires, de réseau ou de confiance pertinents ?\n* *Caractéristiques des groupes*: uelles sont les caractéristiques de ces groupes, telles que la localisation, le niveau de confiance ou l'exposition réseau ?\n* *Emplacements / Zones pertinents*: Quels sont les emplacements, zones ou environnements pertinents au sein de chaque groupe ?\n* *Caractéristiques des emplacements / zones*: Quelles sont les caractéristiques de ces emplacements ou zones, telles que la propriété, la région ou l'exposition ?\n* *Distances réseau / réglementaires*: Quelles sont les distances en termes de latence, de confiance, de réglementation ou de connectivité entre les emplacements ?\n* *Caractéristiques des distance*: Quelles sont les caractéristiques de ces distances, telles que la sensibilité à la latence, les contraintes de résidence ou les limites de confiance ?\n* *Points de terminaison de connectivité*: Quels sont les points de terminaison ou interfaces de connectivité associés aux emplacements ?\n* *Caractéristiques d'accès aux points de terminaison*: Quelles sont les caractéristiques de ces points de terminaison, telles que l'exposition, le protocole, la sécurité ou les restrictions d'accès ?\n\nh4. Capacity Canvas\nQuelle capacité est nécessaire pour soutenir l’usage de la capacité ou de l’interface ?\n* *Volumes d'activité actuels*: Quels sont les volumes d'affaires et taux de transaction actuels?\n* *Tendances de consommation futures*: Quelles sont les tendances de consommation anticipées?\n* *Exigences de charge maximale et de disponibilité*: Quelles sont les exigences de charge maximale et de disponibilité?\n* *Stratégies de mise en cache*: Quelles stratégies de mise en cache peuvent être utilisées pour optimiser les performances?\n* *Stratégies de limitation de débit*: Quelles stratégies de limitation de débit peuvent être utilisées pour gérer la consommation?\n* *Stratégies de montée en charge*: Quelles stratégies d'évolutivité peuvent être utilisées pour accompagner la croissance?\n\nh3. Other related resources\n* *Guide de responsabilité opérationnelle*: Guide pour définir responsabilité, runbooks, supervision, support, suivi, contrôle des changements et amélioration continue.\n\nh2. 4. Conception de workflow d’automatisation\n\nConcevoir le workflow d automatisation, les declencheurs, les points de decision, les integrations, le traitement des donnees, les contrats d interface pertinents et les chemins d exception.\n\nh3. Canvas questions\nh4. Domain Canvas\nQuels concepts, entités et règles de domaine métier la capacité ou l’interface doit-elle respecter ?\n* *Étapes du parcours client sélectionnées*: Quelles étapes du parcours client sont pertinentes pour ce domaine?\n* *Entités principales et signification métier*: Quelles sont les entités principales et leur signification métier?\n* *Attributs et importance métier*: Quels sont les attributs clés de chaque entité et leur importance métier?\n* *Relations entre les entités*: Quelles sont les relations entre les entités?\n* *Règles métier, conformité et intégrité*: Quelles sont les règles métier, de conformité et d'intégrité liées aux entités?\n* *Considérations de sécurité et de confidentialité*: Quelles sont les considérations de sécurité et de confidentialité liées aux entités?\n\nh4. Interaction Canvas\nQuels types d’interactions cette capacité ou interface doit-elle prendre en charge avant de choisir une conception propre au protocole ?\n* *Interactions CRUD*: Quelles interactions CRUD (Create, Read, Update, Delete) sont-elles nécessaires ici?\n* *Modèles d'entrée et de sortie CRUD*: Quels sont les modèles d'entrée et de sortie pour les interactions CRUD, si ce style est nécessaire ?\n* *Traitement et validation CRUD*: QQuelles sont les règles de traitement et de validation pour les interactions CRUD, si ce style est nécessaire ?\n* *Interactions pilotées par requêtes*: Quelles interactions de lecture ou de requête sont nécessaires pour répondre aux questions des utilisateurs ?\n* *Modèles d'entrée et de sortie pilotés par les requêtes*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par les requêtes ?\n* *Traitement et validation pilotés par les requêtes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les requêtes ?\n* *Interactions pilotées par commandes*: Quelles commandes modifiant l'état sont nécessaires, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par commande*: Quels sont les modèles d'entrée et de sortie pour les interactions pilotées par commande, si ce style est nécessaire ?\n* *Traitement et validation pilotés par les commandes*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les commandes, si ce style est nécessaire ?\n* *Interactions pilotées par les événements*: Quels événements doivent être publiés ou consommés, le cas échéant ?\n* *Modèles d'entrée et de sortie pilotés par les événements*: Modèles d'entrée et de sortie pilotés par les événements\n* *Traitement et validation pilotés par les événements*: Quelles sont les règles de traitement et de validation pour les interactions pilotées par les événements, si ce style est requis ?\n\nh3. Other related resources\n* *Guide de conception des processus et workflows*: Guide pour modéliser étapes, rôles, transferts, décisions, états, entrées, sorties et exceptions d’un workflow automatisé.\n* *Guide des décisions et règles métier*: Guide pour capturer règles, seuils, décisions, validations, critères d’éligibilité et responsabilités.\n* *Guide des déclencheurs, transferts et exceptions*: Guide pour définir déclencheurs, transferts humains, exceptions, reprises, actions compensatoires et escalades.\n\nh2. 5. Livraison & operations de l automatisation\n\nConstruisez, testez, déployez, documentez et exploitez l’automatisation avec une responsabilité et des chemins de rollback clairs.\n\nh3. Station questions\n* Utilisez les pratiques de développement pour implémenter le contrat d'interface validé avec les frameworks, bibliothèques et standards d'équipe établis.\n* Construisez l'implémentation de l'API à partir du contrat validé en utilisant des frameworks, des bibliothèques et des normes d'équipe établis.\n* Tester les fonctionnalités, la sécurité et les performances des API à l'aide d'outils de test automatisés.\n* Utiliser les pipelines CI/CD pour automatiser les processus de construction, de test et de déploiement, en garantissant une qualité et une traçabilité constantes.\n* S'assurer que les API répondent aux exigences de sécurité et de conformité grâce à des contrôles et des audits automatisés.\n* Utilisez la liste de contrôle de l'audit de l'API pour vous assurer que l'API répond aux exigences fonctionnelles et non fonctionnelles, notamment en matière de sécurité, de performances et de conformité.\n* Appliquez les pratiques de mise en œuvre, de test, de CI/CD, d'exploitation et de sécurité au mode de mise en œuvre choisi.\n* Une capacité réutilisable a besoin d'une mise à disposition et d'un fonctionnement fiables, qu'elle soit réalisée sous forme d'API, de flux d'événements, d'échange de fichiers, de produit de données ou d'intégration directe.\n\nh3. Other related resources\n* *Guide de test des automatisations*: Guide pour tester workflows, décisions, intégrations, exceptions, rollback, supervision et impact utilisateur.\n* *Guide de responsabilité opérationnelle*: Guide pour définir responsabilité, runbooks, supervision, support, suivi, contrôle des changements et amélioration continue.\n* *Guide de rollback et supervision*: Guide pour concevoir rollback, pause, dérogation manuelle, suivi, supervision et reprise.\n\nh2. 6. Revue de préparation de l’automatisation\n\nRevoyez la préparation, la qualité, les risques, la conformité, la supervision humaine, les preuves et les critères de publication de l’automatisation.\n\nh3. Station questions\n* Utilisez des checklists, linters, tests et revues pour vérifier cohérence, standards, sécurité, performance et conformité.\n* Utiliser des listes de contrôle, des linters et des outils de test pour vérifier la cohérence et la conformité avec les normes.\n* Collaborer avec les équipes de gouvernance et les experts du domaine pour s'assurer que les API sont prêtes pour la production.\n* Utilisez les ressources d'audit et de conformité pour vérifier que la capacité peut être publiée et réutilisée de manière contrôlée.\n* Les capacités réutilisables créent des risques opérationnels, liés aux données, à la sécurité, à la confidentialité, à la conformité et à l'expérience utilisateur. Les revues de préparation réduisent les surprises avant la publication ou l'utilisation en production.\n\nh3. Other related resources\n* *Checklist de préparation des automatisations*: Checklist pour valider workflow, contrôles, risques, conformité, supervision humaine, preuves de test, rollback, opérations et préparation.\n* *Meilleures pratiques en matière de conformité de l'API*: Veiller à ce que les API respectent la conformité légale, réglementaire et interne grâce à la documentation, aux contrôles et aux validations automatisées.\n\nh2. 7. Deploiement & enablement de l automatisation\n\nEnablez les utilisateurs et opérateurs avec découverte, onboarding, instructions d’exploitation, chemins de support et communication de changement.\n\nh3. Station questions\n* Publiez les informations de capacité dans les catalogues, portails, passerelles ou environnements appropriés afin que plusieurs utilisateurs puissent la réutiliser.\n* Documenter la manière dont les utilisateurs trouvent et utilisent l'API, y compris les processus d'accueil et d'enregistrement.\n* Veiller à ce que les modèles de sécurité, la configuration de la passerelle et les termes juridiques soient clairs et accessibles aux utilisateurs.\n* Publiez la responsabilité, la documentation, l'onboarding, les contacts support, les attentes de service, le statut de cycle de vie et les chemins d'accès.\n* Une capacité réutilisable ne crée de la valeur que si les utilisateurs peuvent la trouver, comprendre le contrat d'interface et les attentes de service, demander l'accès et connaître le support ainsi que la responsabilité du cycle de vie.\n\nh3. Other related resources\n* *Guide de déploiement et d’enablement*: Guide pour déployer les automatisations avec communication, onboarding, instructions d’exploitation, support, conduite du changement et feedback.\n* *Modèle de contrat de service*: Un format d'accord personnalisable qui définit les attentes, les accords de niveau de service, les responsabilités et les conditions d'accès pour la consommation d'API.\n\nh2. 8. Suivi & amélioration de l’automatisation\n\nSuivez la performance de l’automatisation, les exceptions, la fiabilité, les résultats utilisateurs, l’impact opérationnel et les opportunités d’amélioration.\n\nh3. Station questions\n* Définissez des métriques d'utilisation, fiabilité, qualité des données, coût, adoption et valeur utilisateur.\n* Analyser les indicateurs d'utilisation de l'API et intégrer les commentaires des utilisateurs dans les itérations de l'API.\n* Prendre l'habitude d'examiner les mesures et de planifier des activités d'amélioration continue.\n* Utilisez des métriques, analyses et pratiques de feedback pour améliorer continuellement la capacité.\n* Les capacités ont besoin de retours continus pour rester fiables, utiles, économiquement pertinentes et réutilisables lorsque les utilisateurs, systèmes, données et plateformes évoluent.\n\nh3. Other related resources\n* *Guide de responsabilité opérationnelle*: Guide pour définir responsabilité, runbooks, supervision, support, suivi, contrôle des changements et amélioration continue.\n* *Mesures et analyses de l'API*: Une ressource pour définir, collecter et analyser les performances de l'API et les données d'utilisation afin d'aligner les KPI techniques sur les résultats de l'entreprise." } ] } }