{
  "source": {
    "repository": "https://github.com/APIOpsCycles/apiops-cycles-method-data",
    "commit": "4e3a61e4c0427a5b86a79a362e5eed172409434c"
  },
  "locales": [
    "en",
    "fi",
    "fr",
    "de",
    "pt"
  ],
  "defaultLocale": "en",
  "translations": {
    "en": [
      {
        "id": "capability-productization-cycle:question-template-markdown",
        "cycleId": "capability-productization-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Capability Productization Cycle question template Markdown",
        "body": "# Capability Productization Cycle question template\n\nA cycle for turning business capabilities into reusable digital capabilities before selecting the implementation style.\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. Capability Strategy\n\nFrame the business need as a reusable capability with clear value, consumers, ownership, and business goals before selecting the implementation style.\n\n### Canvas questions\n#### Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n- **Persona**: Who is the typical customer experiencing this journey?\n- **Customer Discovers Need**: How does the customer recognize their need or problem?\n- **Customer Need Is Resolved**: How is the customer's need ultimately resolved?\n- **Journey Steps**: What are the steps the customer takes in their journey?\n- **Pains**: What are the customer's pain points or challenges?\n- **Gains**: What are the customer's gains or benefits?\n- **Inputs & Outputs**: What are the inputs and outputs at each step?\n- **Interaction & Processing Rules**: What are the interaction and processing rules at each step?\n\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Capability Value Proposition Canvas\nWhich reusable capability would create value for consumers without deciding yet whether it should be delivered as an API, event, file, stream, data product, or another implementation style?\n- **Consumer tasks and outcomes**: What are consumers, partners, users, systems, or teams trying to achieve?\n- **Gain-enabling capability features**: What capability features would help consumers achieve better outcomes, speed, automation, insight, reach, or compliance?\n- **Pain-relieving capability features**: What capability features would remove friction, manual work, errors, delays, risk, or uncertainty for consumers?\n- **Reusable capabilities**: What reusable business or data capabilities could serve these tasks, gains, and pains across more than one consumer or use case?\n\n#### Capability Business Model Canvas\nHow viable, reusable, funded, owned, supported, and discoverable should this integration capability be?\n- **Capability value proposition**: What value does this reusable capability provide to consumers and to the organization or ecosystem?\n- **Capability consumer segments**: Who are the current and potential consumers of the capability, including teams, partners, systems, products, or data users?\n- **Consumer engagement**: How will consumers discover, evaluate, request, onboard, get support for, and provide feedback on the capability?\n- **Channels**: Through which catalogs, portals, marketplaces, documentation sites, support paths, or governance processes will consumers interact with the capability?\n- **Key resources**: Which systems, data assets, platforms, people, standards, funding, and operational capabilities are required?\n- **Key activities**: What must the capability owner and producers do to design, deliver, govern, support, and improve the capability?\n- **Key partners**: Which business, technology, data, security, legal, platform, or external partners are needed to make the capability work?\n- **Benefits**: What business, operational, ecosystem, reuse, compliance, or cost benefits justify the capability?\n- **Costs**: What are the significant costs of building, operating, governing, supporting, and evolving the capability?\n\n## 2. Consumer Requirements & Onboarding\n\nCapture consumer requirements, onboarding needs, constraints, service expectations, and producer responsibilities.\n\n### Canvas questions\n#### Consumer Experience Requirements Canvas\nWhat experience and non-functional requirements do consumers need before deciding the best integration architecture?\n- **Consumer goals**: What are the consumer's business goals, workflow goals, decision goals, automation goals, or data usage goals?\n- **Availability and timeliness**: When must the capability be available, how fresh must information be, and what latency or delivery windows matter?\n- **Volume and performance**: What request, event, record, file, batch, user, or transaction volumes must the capability support now and later?\n- **Data quality and consistency**: What accuracy, completeness, consistency, ordering, deduplication, reconciliation, or validation expectations do consumers have?\n- **Security, privacy, and compliance**: What identity, authorization, confidentiality, residency, consent, retention, audit, or regulatory constraints apply?\n- **Onboarding and access**: How should consumers find, request, test, get approved for, and start using the capability?\n- **Change and versioning**: How much change tolerance do consumers have, and what notice, compatibility, migration, or versioning expectations apply?\n- **Observability and support**: What monitoring, status, traceability, data quality visibility, support, ownership, and incident communication do consumers need?\n- **Recovery and continuity**: What replay, retry, reconciliation, backup, fallback, continuity, or manual recovery expectations must be supported?\n- **Architecture implications**: What do these requirements imply for possible architecture styles, such as APIs, events, files, streams, data products, or direct integration?\n\n### Other related resources\n- **API Onboarding Best Practices**: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n\n## 3. Architecture & Platform Decisions\n\nUse requirements and constraints to select the implementation style, architecture pattern, and enabling platform capabilities.\n\n### Canvas questions\n#### Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n- **Availability Risks**: What are the potential risks to capability availability?\n- **Mitigate Availability Risks**: How can the capability owner mitigate the availability risks?\n- **Security Risks**: What are the potential security risks associated with the capability?\n- **Mitigate Security Risks**: How can the capability owner mitigate the security risks?\n- **Data Risks**: What are the potential risks to data integrity or confidentiality?\n- **Mitigate Data Risks**: How can the capability owner mitigate the data risks?\n\n#### Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n- **Location / Trust Groups**: What are the relevant geopolitical, regulatory, network, or trust groups?\n- **Group Characteristics**: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n- **Relevant Locations / Zones**: What are the relevant locations, zones, or environments within each group?\n- **Location / Zone Characteristics**: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n- **Network / Regulatory Distances**: What latency, trust, regulatory, or connectivity distances exist between the locations?\n- **Distance Characteristics**: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n- **Connectivity Endpoints**: What connectivity endpoints or interfaces are associated with the locations?\n- **Endpoint Access Characteristics**: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\n#### Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n- **Current Business Volumes**: What are the current business volumes and transaction rates?\n- **Future Consumption Trends**: What are the anticipated future consumption trends?\n- **Peak Load and Availability Requirements**: What are the peak load and availability requirements?\n- **Caching Strategies**: What caching strategies can be used to optimize performance?\n- **Rate Limiting Strategies**: What rate limiting strategies can be used to manage consumption?\n- **Scaling Strategies**: What scaling strategies can be used to accommodate growth?\n\n## 4. Solution & Interface Design\n\nDesign the interface contract and interaction model for the selected implementation style.\n\n### Canvas questions\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n- **CRUD Interactions**: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n- **CRUD Input & Output Models**: What are the input and output models for the CRUD interactions, if this style is needed?\n- **CRUD Processing & Validation**: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n- **Query-Driven Interactions**: What read or query interactions are needed to answer consumer questions?\n- **Query-Driven Input & Output Models**: What are the input and output models for the query-driven interactions?\n- **Query-Driven Processing & Validation**: What are the processing and validation rules for the query-driven interactions?\n- **Command-Driven Interactions**: What state-changing commands are needed, if any?\n- **Command-Driven Input & Output Models**: What are the input and output models for the command-driven interactions, if this style is needed?\n- **Command-Driven Processing & Validation**: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n- **Event-Driven Interactions**: What events need to be published or consumed, if any?\n- **Event-Driven Input & Output Models**: What are the input and output models for the event-driven interactions, if this style is needed?\n- **Event-Driven Processing & Validation**: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\n### Other related resources\n- **Contract First Design**: A guideline advocating for API-first approaches using formal contracts (e.g., OpenAPI) to align stakeholders before development.\n\n## 5. Delivery & Operations\n\nBuild, test, deploy, and operate the capability using the selected implementation style and validated interface contract.\n\n### Station questions\n- Use development best practices to implement the validated interface contract with established frameworks, libraries, and team standards.\n- Build the implementation from the validated interface contract using established frameworks, libraries, and team standards.\n- Use testing guidance to verify functionality, data quality, compatibility, security, performance, resilience, and recovery expectations.\n- Use CI/CD guidance to automate build, test, deployment, configuration, and traceability.\n- Use security guidance to protect data, access, credentials, and platform boundaries.\n- Use the audit checklist to ensure the solution meets functional and non-functional requirements, including security, performance, and compliance.\n- Apply delivery, testing, CI/CD, operations, and security guidance to the chosen implementation style.\n- A reusable capability needs reliable delivery and operations regardless of whether it becomes an API, event stream, file exchange, data product, or direct integration.\n\n### Other related resources\n- **API Development Best Practices**: Implementation guidance for turning a validated API interface contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.\n- **API Testing Best Practices**: Guidelines for implementing automated functional, performance, and security testing throughout the API lifecycle.\n- **APIOps CI/CD For APIs**: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n\n## 6. Quality & Readiness Assurance\n\nValidate the interface contract, controls, documentation, support model, and operational readiness before release.\n\n### Station questions\n- Use the audit checklist as a reusable quality checklist for interface contract, documentation, security, performance, and compliance readiness.\n- Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n- Collaborate with governance teams and domain experts to ensure the capability is ready for production.\n- Use audit and compliance resources to verify that the capability is ready for controlled release and reuse.\n- Reusable capabilities create operational, data, security, privacy, compliance, and consumer-impact risks. Readiness checks reduce surprises before release or production use.\n\n### Other related resources\n- **API Audit Checklist**: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n- **API Compliance Best Practices**: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\n## 7. Publishing & Enablement\n\nPublish the capability so consumers can discover it, evaluate it, request access, complete onboarding, use it, and get support.\n\n### Station questions\n- Publish capability information to the appropriate catalogs, portals, gateways, or environments to support reuse by multiple consumers.\n- Document how consumers find and use the capability, including onboarding processes and registration.\n- Ensure security models, access configuration, and legal terms are clear and accessible to consumers.\n- Publish ownership, documentation, onboarding, support contacts, service expectations, lifecycle status, and access request paths.\n- Reusable capabilities only create value when consumers can find them, understand their interface contract and service expectations, request access, and know who owns support and lifecycle decisions.\n\n### Other related resources\n- **API Onboarding Best Practices**: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n- **Service Agreement Template**: A customizable agreement format that defines expectations, SLAs, responsibilities, and access terms for API consumption.\n\n## 8. Monitoring & Improvement\n\nMonitor capability health, consumer outcomes, reliability, reuse, and improvement opportunities.\n\n### Station questions\n- Use metrics and analytics guidance to define capability usage, reliability, data quality, cost, adoption, and consumer-value measures.\n- Analyze usage metrics and incorporate consumer feedback into capability iterations.\n- Establish a habit of reviewing metrics and planning continuous improvement activities.\n- Use metrics, analytics, and engagement practices to improve the capability over time.\n- Capabilities need continuous feedback to stay reliable, valuable, cost-effective, and reusable as consumers, systems, data, and platforms change.\n\n### Other related resources\n- **API Metrics And Analytics**: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n- **API Community Engagement Strategies**: A playbook for fostering API adoption by cultivating communities through content, support channels, feedback loops, and social engagement strategies."
      },
      {
        "id": "capability-productization-cycle:question-template-confluence-wiki",
        "cycleId": "capability-productization-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Capability Productization Cycle question template Confluence wiki",
        "body": "h1. Capability Productization Cycle question template\n\nA cycle for turning business capabilities into reusable digital capabilities before selecting the implementation style.\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. Capability Strategy\n\nFrame the business need as a reusable capability with clear value, consumers, ownership, and business goals before selecting the implementation style.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n* *Persona*: Who is the typical customer experiencing this journey?\n* *Customer Discovers Need*: How does the customer recognize their need or problem?\n* *Customer Need Is Resolved*: How is the customer's need ultimately resolved?\n* *Journey Steps*: What are the steps the customer takes in their journey?\n* *Pains*: What are the customer's pain points or challenges?\n* *Gains*: What are the customer's gains or benefits?\n* *Inputs & Outputs*: What are the inputs and outputs at each step?\n* *Interaction & Processing Rules*: What are the interaction and processing rules at each step?\n\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Capability Value Proposition Canvas\nWhich reusable capability would create value for consumers without deciding yet whether it should be delivered as an API, event, file, stream, data product, or another implementation style?\n* *Consumer tasks and outcomes*: What are consumers, partners, users, systems, or teams trying to achieve?\n* *Gain-enabling capability features*: What capability features would help consumers achieve better outcomes, speed, automation, insight, reach, or compliance?\n* *Pain-relieving capability features*: What capability features would remove friction, manual work, errors, delays, risk, or uncertainty for consumers?\n* *Reusable capabilities*: What reusable business or data capabilities could serve these tasks, gains, and pains across more than one consumer or use case?\n\nh4. Capability Business Model Canvas\nHow viable, reusable, funded, owned, supported, and discoverable should this integration capability be?\n* *Capability value proposition*: What value does this reusable capability provide to consumers and to the organization or ecosystem?\n* *Capability consumer segments*: Who are the current and potential consumers of the capability, including teams, partners, systems, products, or data users?\n* *Consumer engagement*: How will consumers discover, evaluate, request, onboard, get support for, and provide feedback on the capability?\n* *Channels*: Through which catalogs, portals, marketplaces, documentation sites, support paths, or governance processes will consumers interact with the capability?\n* *Key resources*: Which systems, data assets, platforms, people, standards, funding, and operational capabilities are required?\n* *Key activities*: What must the capability owner and producers do to design, deliver, govern, support, and improve the capability?\n* *Key partners*: Which business, technology, data, security, legal, platform, or external partners are needed to make the capability work?\n* *Benefits*: What business, operational, ecosystem, reuse, compliance, or cost benefits justify the capability?\n* *Costs*: What are the significant costs of building, operating, governing, supporting, and evolving the capability?\n\nh2. 2. Consumer Requirements & Onboarding\n\nCapture consumer requirements, onboarding needs, constraints, service expectations, and producer responsibilities.\n\nh3. Canvas questions\nh4. Consumer Experience Requirements Canvas\nWhat experience and non-functional requirements do consumers need before deciding the best integration architecture?\n* *Consumer goals*: What are the consumer's business goals, workflow goals, decision goals, automation goals, or data usage goals?\n* *Availability and timeliness*: When must the capability be available, how fresh must information be, and what latency or delivery windows matter?\n* *Volume and performance*: What request, event, record, file, batch, user, or transaction volumes must the capability support now and later?\n* *Data quality and consistency*: What accuracy, completeness, consistency, ordering, deduplication, reconciliation, or validation expectations do consumers have?\n* *Security, privacy, and compliance*: What identity, authorization, confidentiality, residency, consent, retention, audit, or regulatory constraints apply?\n* *Onboarding and access*: How should consumers find, request, test, get approved for, and start using the capability?\n* *Change and versioning*: How much change tolerance do consumers have, and what notice, compatibility, migration, or versioning expectations apply?\n* *Observability and support*: What monitoring, status, traceability, data quality visibility, support, ownership, and incident communication do consumers need?\n* *Recovery and continuity*: What replay, retry, reconciliation, backup, fallback, continuity, or manual recovery expectations must be supported?\n* *Architecture implications*: What do these requirements imply for possible architecture styles, such as APIs, events, files, streams, data products, or direct integration?\n\nh3. Other related resources\n* *API Onboarding Best Practices*: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n\nh2. 3. Architecture & Platform Decisions\n\nUse requirements and constraints to select the implementation style, architecture pattern, and enabling platform capabilities.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n* *Availability Risks*: What are the potential risks to capability availability?\n* *Mitigate Availability Risks*: How can the capability owner mitigate the availability risks?\n* *Security Risks*: What are the potential security risks associated with the capability?\n* *Mitigate Security Risks*: How can the capability owner mitigate the security risks?\n* *Data Risks*: What are the potential risks to data integrity or confidentiality?\n* *Mitigate Data Risks*: How can the capability owner mitigate the data risks?\n\nh4. Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n* *Location / Trust Groups*: What are the relevant geopolitical, regulatory, network, or trust groups?\n* *Group Characteristics*: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n* *Relevant Locations / Zones*: What are the relevant locations, zones, or environments within each group?\n* *Location / Zone Characteristics*: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n* *Network / Regulatory Distances*: What latency, trust, regulatory, or connectivity distances exist between the locations?\n* *Distance Characteristics*: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n* *Connectivity Endpoints*: What connectivity endpoints or interfaces are associated with the locations?\n* *Endpoint Access Characteristics*: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\nh4. Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n* *Current Business Volumes*: What are the current business volumes and transaction rates?\n* *Future Consumption Trends*: What are the anticipated future consumption trends?\n* *Peak Load and Availability Requirements*: What are the peak load and availability requirements?\n* *Caching Strategies*: What caching strategies can be used to optimize performance?\n* *Rate Limiting Strategies*: What rate limiting strategies can be used to manage consumption?\n* *Scaling Strategies*: What scaling strategies can be used to accommodate growth?\n\nh2. 4. Solution & Interface Design\n\nDesign the interface contract and interaction model for the selected implementation style.\n\nh3. Canvas questions\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n* *CRUD Interactions*: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n* *CRUD Input & Output Models*: What are the input and output models for the CRUD interactions, if this style is needed?\n* *CRUD Processing & Validation*: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n* *Query-Driven Interactions*: What read or query interactions are needed to answer consumer questions?\n* *Query-Driven Input & Output Models*: What are the input and output models for the query-driven interactions?\n* *Query-Driven Processing & Validation*: What are the processing and validation rules for the query-driven interactions?\n* *Command-Driven Interactions*: What state-changing commands are needed, if any?\n* *Command-Driven Input & Output Models*: What are the input and output models for the command-driven interactions, if this style is needed?\n* *Command-Driven Processing & Validation*: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n* *Event-Driven Interactions*: What events need to be published or consumed, if any?\n* *Event-Driven Input & Output Models*: What are the input and output models for the event-driven interactions, if this style is needed?\n* *Event-Driven Processing & Validation*: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\nh3. Other related resources\n* *Contract First Design*: A guideline advocating for API-first approaches using formal contracts (e.g., OpenAPI) to align stakeholders before development.\n\nh2. 5. Delivery & Operations\n\nBuild, test, deploy, and operate the capability using the selected implementation style and validated interface contract.\n\nh3. Station questions\n* Use development best practices to implement the validated interface contract with established frameworks, libraries, and team standards.\n* Build the implementation from the validated interface contract using established frameworks, libraries, and team standards.\n* Use testing guidance to verify functionality, data quality, compatibility, security, performance, resilience, and recovery expectations.\n* Use CI/CD guidance to automate build, test, deployment, configuration, and traceability.\n* Use security guidance to protect data, access, credentials, and platform boundaries.\n* Use the audit checklist to ensure the solution meets functional and non-functional requirements, including security, performance, and compliance.\n* Apply delivery, testing, CI/CD, operations, and security guidance to the chosen implementation style.\n* A reusable capability needs reliable delivery and operations regardless of whether it becomes an API, event stream, file exchange, data product, or direct integration.\n\nh3. Other related resources\n* *API Development Best Practices*: Implementation guidance for turning a validated API interface contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.\n* *API Testing Best Practices*: Guidelines for implementing automated functional, performance, and security testing throughout the API lifecycle.\n* *APIOps CI/CD For APIs*: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n\nh2. 6. Quality & Readiness Assurance\n\nValidate the interface contract, controls, documentation, support model, and operational readiness before release.\n\nh3. Station questions\n* Use the audit checklist as a reusable quality checklist for interface contract, documentation, security, performance, and compliance readiness.\n* Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n* Collaborate with governance teams and domain experts to ensure the capability is ready for production.\n* Use audit and compliance resources to verify that the capability is ready for controlled release and reuse.\n* Reusable capabilities create operational, data, security, privacy, compliance, and consumer-impact risks. Readiness checks reduce surprises before release or production use.\n\nh3. Other related resources\n* *API Audit Checklist*: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n* *API Compliance Best Practices*: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\nh2. 7. Publishing & Enablement\n\nPublish the capability so consumers can discover it, evaluate it, request access, complete onboarding, use it, and get support.\n\nh3. Station questions\n* Publish capability information to the appropriate catalogs, portals, gateways, or environments to support reuse by multiple consumers.\n* Document how consumers find and use the capability, including onboarding processes and registration.\n* Ensure security models, access configuration, and legal terms are clear and accessible to consumers.\n* Publish ownership, documentation, onboarding, support contacts, service expectations, lifecycle status, and access request paths.\n* Reusable capabilities only create value when consumers can find them, understand their interface contract and service expectations, request access, and know who owns support and lifecycle decisions.\n\nh3. Other related resources\n* *API Onboarding Best Practices*: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n* *Service Agreement Template*: A customizable agreement format that defines expectations, SLAs, responsibilities, and access terms for API consumption.\n\nh2. 8. Monitoring & Improvement\n\nMonitor capability health, consumer outcomes, reliability, reuse, and improvement opportunities.\n\nh3. Station questions\n* Use metrics and analytics guidance to define capability usage, reliability, data quality, cost, adoption, and consumer-value measures.\n* Analyze usage metrics and incorporate consumer feedback into capability iterations.\n* Establish a habit of reviewing metrics and planning continuous improvement activities.\n* Use metrics, analytics, and engagement practices to improve the capability over time.\n* Capabilities need continuous feedback to stay reliable, valuable, cost-effective, and reusable as consumers, systems, data, and platforms change.\n\nh3. Other related resources\n* *API Metrics And Analytics*: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n* *API Community Engagement Strategies*: A playbook for fostering API adoption by cultivating communities through content, support channels, feedback loops, and social engagement strategies."
      },
      {
        "id": "api-productization-cycle:question-template-markdown",
        "cycleId": "api-productization-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "API Productization Cycle question template Markdown",
        "body": "# API Productization Cycle question template\n\nThe API-focused APIOps Cycles journey for productizing, designing, delivering, publishing, and improving APIs.\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. API Product Strategy\n\nBefore building anything, define your API's value, users, and business goals from day one.\n\n### Canvas questions\n#### Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n- **Persona**: Who is the typical customer experiencing this journey?\n- **Customer Discovers Need**: How does the customer recognize their need or problem?\n- **Customer Need Is Resolved**: How is the customer's need ultimately resolved?\n- **Journey Steps**: What are the steps the customer takes in their journey?\n- **Pains**: What are the customer's pain points or challenges?\n- **Gains**: What are the customer's gains or benefits?\n- **Inputs & Outputs**: What are the inputs and outputs at each step?\n- **Interaction & Processing Rules**: What are the interaction and processing rules at each step?\n\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### API Value Proposition Canvas\nHow does the customer journey map to APIs? What end-user and API consumer pains, and gains need to be addressed?\n- **Tasks**: What are the customers (end-users) trying to achieve?\n- **Gain Enabling Features**: What features enable end-users and API consumers to achieve gains?\n- **Pain Relieving Features**: What features help end-users and  API consumers overcome pains?\n- **API Products**: What API products and features address the tasks, pains, and gains?\n\n#### API Business Model Canvas\nHow feasible and reusable will this API be? Do we have a business case from a cost - benefit point of view?\n- **API Value Proposition**: Start with one sticky note naming the API or API family, then capture what value the API offers to API consumers.\n- **API Consumer Segments**: Who are the target audiences for the API?\n- **Developer Relations**: How does the API provider reach and support API consumers?\n- **Channels**: Through which mechanisms do API consumers interact with the API?\n- **Key Resources**: What unique strategic assets must the API provider acquire or build?\n- **Key Activities**: What are the most important actions the API provider must take to operate successfully?\n- **Key Partners**: Who are the key stakeholders involved?\n- **Benefits**: What are the significant benefits or revenue streams generated by the API?\n- **Costs**: What are the significant costs involved in building, deploying, and operating the API?\n\n## 2. API Consumer Experience\n\nEnsure your API is discoverable, understandable, and usable — before and after launch.\n\n### Canvas questions\n#### API Value Proposition Canvas\nHow does the customer journey map to APIs? What end-user and API consumer pains, and gains need to be addressed?\n- **Tasks**: What are the customers (end-users) trying to achieve?\n- **Gain Enabling Features**: What features enable end-users and API consumers to achieve gains?\n- **Pain Relieving Features**: What features help end-users and  API consumers overcome pains?\n- **API Products**: What API products and features address the tasks, pains, and gains?\n\n#### Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n- **Persona**: Who is the typical customer experiencing this journey?\n- **Customer Discovers Need**: How does the customer recognize their need or problem?\n- **Customer Need Is Resolved**: How is the customer's need ultimately resolved?\n- **Journey Steps**: What are the steps the customer takes in their journey?\n- **Pains**: What are the customer's pain points or challenges?\n- **Gains**: What are the customer's gains or benefits?\n- **Inputs & Outputs**: What are the inputs and outputs at each step?\n- **Interaction & Processing Rules**: What are the interaction and processing rules at each step?\n\n### Other related resources\n- **API Onboarding Best Practices**: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n\n## 3. API Platform Architecture\n\nEnsure scalability, reuse, and governance across your API and platform components.\n\n### Canvas questions\n#### Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n- **Availability Risks**: What are the potential risks to capability availability?\n- **Mitigate Availability Risks**: How can the capability owner mitigate the availability risks?\n- **Security Risks**: What are the potential security risks associated with the capability?\n- **Mitigate Security Risks**: How can the capability owner mitigate the security risks?\n- **Data Risks**: What are the potential risks to data integrity or confidentiality?\n- **Mitigate Data Risks**: How can the capability owner mitigate the data risks?\n\n#### Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n- **Location / Trust Groups**: What are the relevant geopolitical, regulatory, network, or trust groups?\n- **Group Characteristics**: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n- **Relevant Locations / Zones**: What are the relevant locations, zones, or environments within each group?\n- **Location / Zone Characteristics**: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n- **Network / Regulatory Distances**: What latency, trust, regulatory, or connectivity distances exist between the locations?\n- **Distance Characteristics**: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n- **Connectivity Endpoints**: What connectivity endpoints or interfaces are associated with the locations?\n- **Endpoint Access Characteristics**: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\n#### Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n- **Current Business Volumes**: What are the current business volumes and transaction rates?\n- **Future Consumption Trends**: What are the anticipated future consumption trends?\n- **Peak Load and Availability Requirements**: What are the peak load and availability requirements?\n- **Caching Strategies**: What caching strategies can be used to optimize performance?\n- **Rate Limiting Strategies**: What rate limiting strategies can be used to manage consumption?\n- **Scaling Strategies**: What scaling strategies can be used to accommodate growth?\n\n### Other related resources\n- **API Metrics And Analytics**: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n\n## 4. API Design\n\nCreate API designs that are consistent, reusable, and grounded in business intent and shared standards.\n\n### Canvas questions\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n- **CRUD Interactions**: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n- **CRUD Input & Output Models**: What are the input and output models for the CRUD interactions, if this style is needed?\n- **CRUD Processing & Validation**: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n- **Query-Driven Interactions**: What read or query interactions are needed to answer consumer questions?\n- **Query-Driven Input & Output Models**: What are the input and output models for the query-driven interactions?\n- **Query-Driven Processing & Validation**: What are the processing and validation rules for the query-driven interactions?\n- **Command-Driven Interactions**: What state-changing commands are needed, if any?\n- **Command-Driven Input & Output Models**: What are the input and output models for the command-driven interactions, if this style is needed?\n- **Command-Driven Processing & Validation**: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n- **Event-Driven Interactions**: What events need to be published or consumed, if any?\n- **Event-Driven Input & Output Models**: What are the input and output models for the event-driven interactions, if this style is needed?\n- **Event-Driven Processing & Validation**: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\n#### REST Canvas\nHow can the API be designed using RESTful principles?\n- **API Resources**: What are the key resources exposed by the API?\n- **API Resource Model**: What is the structure of the API resource model?\n- **API Verbs**: What HTTP verbs are used to interact with the API resources?\n- **API Verb Example**: Provide an example of an API request and response for each verb.\n\n#### Event Canvas\nWhat events are relevant to the API, and how are they processed?\n- **User Task / Trigger**: What user action or system event triggers this event operation?\n- **Input / Event Payload**: What data is included in the incoming event payload? Specify key attributes.\n- **Processing / Logic**: Describe the backend processing logic, including validations, transformations, or routing decisions.\n- **Output / Event Result**: What resulting event or acknowledgment is produced? Include attributes of the output payload.\n\n#### GraphQL Canvas\nHow can the API be designed using GraphQL principles?\n- **API Name**: What is the name of the GraphQL API or endpoint?\n- **Consumer Goals**: What problems are API consumers trying to solve? What data do they need?\n- **Key Types**: What are the core types exposed (e.g., User, Order, Product)?\n- **Relationships**: How do types relate to each other in nested queries?\n- **Queries**: What common queries should be supported?\n- **Mutations**: What operations will modify data (e.g., create, update, delete)?\n- **Subscriptions**: Are there any real-time updates or events consumers can subscribe to?\n- **Authorization Rules**: Who can access which fields or types?\n- **Consumer Constraints**: Are there pagination, filtering, or rate-limiting constraints?\n- **Notes / Open Questions**: Any pending decisions or integration considerations?\n\n### Other related resources\n- **API Design Principles**: A concise guide to API usability, discoverability, and consistency grounded in shared design rules and real consumer needs.\n- **Contract First Design**: A guideline advocating for API-first approaches using formal contracts (e.g., OpenAPI) to align stakeholders before development.\n\n## 5. API Delivery\n\nBuild, test, and release APIs using modern delivery pipelines and engineering best practices.\n\n### Station questions\n- Use API Development Best Practices as guidance for implementing the validated contract with established frameworks and libraries, ensuring the result is reusable and maintainable.\n- Build the API implementation from the validated contract using established frameworks, libraries, and team standards.\n- Test APIs for functionality, security, and performance using automated testing tools.\n- Use CI/CD pipelines to automate build, test, and deployment processes, ensuring consistent quality and traceability.\n- Ensure APIs meet security and compliance requirements through automated checks and audits.\n- Use the API Audit Checklist to ensure the API meets functional and non-functional requirements, including security, performance, and compliance.\n- Deliver coding frameworks, libraries, and standards for API implementation. Implement CI/CD pipelines, quality assurance frameworks, and deployment automation tools.\n- Even the best API designs fail if delivery is inconsistent. This station ensures your APIs are built with quality, tested thoroughly, and deployed reliably — enabling faster iterations and greater confidence.\n\n### Other related resources\n- **API Development Best Practices**: Implementation guidance for turning a validated API interface contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.\n- **API Testing Best Practices**: Guidelines for implementing automated functional, performance, and security testing throughout the API lifecycle.\n- **APIOps CI/CD For APIs**: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n- **API Security Best Practices**: A set of actionable controls for securing APIs, including authentication, authorization, encryption, rate-limiting, and pipeline-level compliance checks.\n\n## 6. API Audit\n\nValidate that APIs meet business, design, and operational standards before release.\n\n### Station questions\n- Conduct audits to ensure APIs meet organizational, technical, and legal standards before release.\n- Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n- Collaborate with governance teams and domain experts to ensure APIs are ready for production.\n- Establish a consistent audit process that evaluates API readiness across lifecycle stages using defined criteria, evidence, and standards. Ensure gaps are identified early and resolved before release.\n- APIs are long-lived products and must meet expectations for quality, consistency, and compliance. The audit connects design decisions, implementation, and operational readiness to defined standards, reducing risk before exposure.\n\n### Other related resources\n- **API Audit Checklist**: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n- **API Compliance Best Practices**: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\n## 7. API Publishing\n\nExpose APIs securely and clearly to the right audience with the right documentation and processes.\n\n### Station questions\n- Publish APIs to the appropriate gateways and environments to support reusability for multiple API consumers.\n- Document how consumers find and use the API, including onboarding processes and registration.\n- Ensure security models, gateway configuration, and legal terms are clear and accessible to consumers.\n- Enable APIs to be published to the relevant environment and have clear registration and access mechanisms (e.g., API keys, OAuth, subscription plans) depending on the API consumer segments and security and compliance requirements.\n- Publishing is more than deploying — it’s about discoverability, access, and support. If APIs aren't published correctly, they won’t be used, reused, or secured effectively.\n\n### Other related resources\n- **APIOps CI/CD For APIs**: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n- **API Onboarding Best Practices**: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n- **API Audit Checklist**: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n\n## 8. API Monitoring & Improvement\n\nUse metrics and feedback to track API performance and drive continuous improvement.\n\n### Station questions\n- Monitor performance metrics (e.g., API calls, latency, error rates) and adoption metrics (e.g., NPS).\n- Analyze API usage metrics and incorporate user feedback into API iterations.\n- Establish a habit of reviewing metrics and planning continuous improvement activities.\n- Set up analytics frameworks to track performance and engagement. Develop feedback loops, analytics tools, and engagement strategies for APIs.\n- API delivery doesn’t stop at launch. Without monitoring, teams can’t improve adoption, performance, or ROI. This station ensures APIs remain useful, secure, and evolving with business needs.\n\n### Other related resources\n- **API Metrics And Analytics**: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n- **API Community Engagement Strategies**: A playbook for fostering API adoption by cultivating communities through content, support channels, feedback loops, and social engagement strategies."
      },
      {
        "id": "api-productization-cycle:question-template-confluence-wiki",
        "cycleId": "api-productization-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "API Productization Cycle question template Confluence wiki",
        "body": "h1. API Productization Cycle question template\n\nThe API-focused APIOps Cycles journey for productizing, designing, delivering, publishing, and improving APIs.\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. API Product Strategy\n\nBefore building anything, define your API's value, users, and business goals from day one.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n* *Persona*: Who is the typical customer experiencing this journey?\n* *Customer Discovers Need*: How does the customer recognize their need or problem?\n* *Customer Need Is Resolved*: How is the customer's need ultimately resolved?\n* *Journey Steps*: What are the steps the customer takes in their journey?\n* *Pains*: What are the customer's pain points or challenges?\n* *Gains*: What are the customer's gains or benefits?\n* *Inputs & Outputs*: What are the inputs and outputs at each step?\n* *Interaction & Processing Rules*: What are the interaction and processing rules at each step?\n\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. API Value Proposition Canvas\nHow does the customer journey map to APIs? What end-user and API consumer pains, and gains need to be addressed?\n* *Tasks*: What are the customers (end-users) trying to achieve?\n* *Gain Enabling Features*: What features enable end-users and API consumers to achieve gains?\n* *Pain Relieving Features*: What features help end-users and  API consumers overcome pains?\n* *API Products*: What API products and features address the tasks, pains, and gains?\n\nh4. API Business Model Canvas\nHow feasible and reusable will this API be? Do we have a business case from a cost - benefit point of view?\n* *API Value Proposition*: Start with one sticky note naming the API or API family, then capture what value the API offers to API consumers.\n* *API Consumer Segments*: Who are the target audiences for the API?\n* *Developer Relations*: How does the API provider reach and support API consumers?\n* *Channels*: Through which mechanisms do API consumers interact with the API?\n* *Key Resources*: What unique strategic assets must the API provider acquire or build?\n* *Key Activities*: What are the most important actions the API provider must take to operate successfully?\n* *Key Partners*: Who are the key stakeholders involved?\n* *Benefits*: What are the significant benefits or revenue streams generated by the API?\n* *Costs*: What are the significant costs involved in building, deploying, and operating the API?\n\nh2. 2. API Consumer Experience\n\nEnsure your API is discoverable, understandable, and usable — before and after launch.\n\nh3. Canvas questions\nh4. API Value Proposition Canvas\nHow does the customer journey map to APIs? What end-user and API consumer pains, and gains need to be addressed?\n* *Tasks*: What are the customers (end-users) trying to achieve?\n* *Gain Enabling Features*: What features enable end-users and API consumers to achieve gains?\n* *Pain Relieving Features*: What features help end-users and  API consumers overcome pains?\n* *API Products*: What API products and features address the tasks, pains, and gains?\n\nh4. Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n* *Persona*: Who is the typical customer experiencing this journey?\n* *Customer Discovers Need*: How does the customer recognize their need or problem?\n* *Customer Need Is Resolved*: How is the customer's need ultimately resolved?\n* *Journey Steps*: What are the steps the customer takes in their journey?\n* *Pains*: What are the customer's pain points or challenges?\n* *Gains*: What are the customer's gains or benefits?\n* *Inputs & Outputs*: What are the inputs and outputs at each step?\n* *Interaction & Processing Rules*: What are the interaction and processing rules at each step?\n\nh3. Other related resources\n* *API Onboarding Best Practices*: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n\nh2. 3. API Platform Architecture\n\nEnsure scalability, reuse, and governance across your API and platform components.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n* *Availability Risks*: What are the potential risks to capability availability?\n* *Mitigate Availability Risks*: How can the capability owner mitigate the availability risks?\n* *Security Risks*: What are the potential security risks associated with the capability?\n* *Mitigate Security Risks*: How can the capability owner mitigate the security risks?\n* *Data Risks*: What are the potential risks to data integrity or confidentiality?\n* *Mitigate Data Risks*: How can the capability owner mitigate the data risks?\n\nh4. Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n* *Location / Trust Groups*: What are the relevant geopolitical, regulatory, network, or trust groups?\n* *Group Characteristics*: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n* *Relevant Locations / Zones*: What are the relevant locations, zones, or environments within each group?\n* *Location / Zone Characteristics*: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n* *Network / Regulatory Distances*: What latency, trust, regulatory, or connectivity distances exist between the locations?\n* *Distance Characteristics*: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n* *Connectivity Endpoints*: What connectivity endpoints or interfaces are associated with the locations?\n* *Endpoint Access Characteristics*: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\nh4. Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n* *Current Business Volumes*: What are the current business volumes and transaction rates?\n* *Future Consumption Trends*: What are the anticipated future consumption trends?\n* *Peak Load and Availability Requirements*: What are the peak load and availability requirements?\n* *Caching Strategies*: What caching strategies can be used to optimize performance?\n* *Rate Limiting Strategies*: What rate limiting strategies can be used to manage consumption?\n* *Scaling Strategies*: What scaling strategies can be used to accommodate growth?\n\nh3. Other related resources\n* *API Metrics And Analytics*: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n\nh2. 4. API Design\n\nCreate API designs that are consistent, reusable, and grounded in business intent and shared standards.\n\nh3. Canvas questions\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n* *CRUD Interactions*: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n* *CRUD Input & Output Models*: What are the input and output models for the CRUD interactions, if this style is needed?\n* *CRUD Processing & Validation*: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n* *Query-Driven Interactions*: What read or query interactions are needed to answer consumer questions?\n* *Query-Driven Input & Output Models*: What are the input and output models for the query-driven interactions?\n* *Query-Driven Processing & Validation*: What are the processing and validation rules for the query-driven interactions?\n* *Command-Driven Interactions*: What state-changing commands are needed, if any?\n* *Command-Driven Input & Output Models*: What are the input and output models for the command-driven interactions, if this style is needed?\n* *Command-Driven Processing & Validation*: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n* *Event-Driven Interactions*: What events need to be published or consumed, if any?\n* *Event-Driven Input & Output Models*: What are the input and output models for the event-driven interactions, if this style is needed?\n* *Event-Driven Processing & Validation*: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\nh4. REST Canvas\nHow can the API be designed using RESTful principles?\n* *API Resources*: What are the key resources exposed by the API?\n* *API Resource Model*: What is the structure of the API resource model?\n* *API Verbs*: What HTTP verbs are used to interact with the API resources?\n* *API Verb Example*: Provide an example of an API request and response for each verb.\n\nh4. Event Canvas\nWhat events are relevant to the API, and how are they processed?\n* *User Task / Trigger*: What user action or system event triggers this event operation?\n* *Input / Event Payload*: What data is included in the incoming event payload? Specify key attributes.\n* *Processing / Logic*: Describe the backend processing logic, including validations, transformations, or routing decisions.\n* *Output / Event Result*: What resulting event or acknowledgment is produced? Include attributes of the output payload.\n\nh4. GraphQL Canvas\nHow can the API be designed using GraphQL principles?\n* *API Name*: What is the name of the GraphQL API or endpoint?\n* *Consumer Goals*: What problems are API consumers trying to solve? What data do they need?\n* *Key Types*: What are the core types exposed (e.g., User, Order, Product)?\n* *Relationships*: How do types relate to each other in nested queries?\n* *Queries*: What common queries should be supported?\n* *Mutations*: What operations will modify data (e.g., create, update, delete)?\n* *Subscriptions*: Are there any real-time updates or events consumers can subscribe to?\n* *Authorization Rules*: Who can access which fields or types?\n* *Consumer Constraints*: Are there pagination, filtering, or rate-limiting constraints?\n* *Notes / Open Questions*: Any pending decisions or integration considerations?\n\nh3. Other related resources\n* *API Design Principles*: A concise guide to API usability, discoverability, and consistency grounded in shared design rules and real consumer needs.\n* *Contract First Design*: A guideline advocating for API-first approaches using formal contracts (e.g., OpenAPI) to align stakeholders before development.\n\nh2. 5. API Delivery\n\nBuild, test, and release APIs using modern delivery pipelines and engineering best practices.\n\nh3. Station questions\n* Use API Development Best Practices as guidance for implementing the validated contract with established frameworks and libraries, ensuring the result is reusable and maintainable.\n* Build the API implementation from the validated contract using established frameworks, libraries, and team standards.\n* Test APIs for functionality, security, and performance using automated testing tools.\n* Use CI/CD pipelines to automate build, test, and deployment processes, ensuring consistent quality and traceability.\n* Ensure APIs meet security and compliance requirements through automated checks and audits.\n* Use the API Audit Checklist to ensure the API meets functional and non-functional requirements, including security, performance, and compliance.\n* Deliver coding frameworks, libraries, and standards for API implementation. Implement CI/CD pipelines, quality assurance frameworks, and deployment automation tools.\n* Even the best API designs fail if delivery is inconsistent. This station ensures your APIs are built with quality, tested thoroughly, and deployed reliably — enabling faster iterations and greater confidence.\n\nh3. Other related resources\n* *API Development Best Practices*: Implementation guidance for turning a validated API interface contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.\n* *API Testing Best Practices*: Guidelines for implementing automated functional, performance, and security testing throughout the API lifecycle.\n* *APIOps CI/CD For APIs*: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n* *API Security Best Practices*: A set of actionable controls for securing APIs, including authentication, authorization, encryption, rate-limiting, and pipeline-level compliance checks.\n\nh2. 6. API Audit\n\nValidate that APIs meet business, design, and operational standards before release.\n\nh3. Station questions\n* Conduct audits to ensure APIs meet organizational, technical, and legal standards before release.\n* Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n* Collaborate with governance teams and domain experts to ensure APIs are ready for production.\n* Establish a consistent audit process that evaluates API readiness across lifecycle stages using defined criteria, evidence, and standards. Ensure gaps are identified early and resolved before release.\n* APIs are long-lived products and must meet expectations for quality, consistency, and compliance. The audit connects design decisions, implementation, and operational readiness to defined standards, reducing risk before exposure.\n\nh3. Other related resources\n* *API Audit Checklist*: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n* *API Compliance Best Practices*: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\nh2. 7. API Publishing\n\nExpose APIs securely and clearly to the right audience with the right documentation and processes.\n\nh3. Station questions\n* Publish APIs to the appropriate gateways and environments to support reusability for multiple API consumers.\n* Document how consumers find and use the API, including onboarding processes and registration.\n* Ensure security models, gateway configuration, and legal terms are clear and accessible to consumers.\n* Enable APIs to be published to the relevant environment and have clear registration and access mechanisms (e.g., API keys, OAuth, subscription plans) depending on the API consumer segments and security and compliance requirements.\n* Publishing is more than deploying — it’s about discoverability, access, and support. If APIs aren't published correctly, they won’t be used, reused, or secured effectively.\n\nh3. Other related resources\n* *APIOps CI/CD For APIs*: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n* *API Onboarding Best Practices*: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n* *API Audit Checklist*: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n\nh2. 8. API Monitoring & Improvement\n\nUse metrics and feedback to track API performance and drive continuous improvement.\n\nh3. Station questions\n* Monitor performance metrics (e.g., API calls, latency, error rates) and adoption metrics (e.g., NPS).\n* Analyze API usage metrics and incorporate user feedback into API iterations.\n* Establish a habit of reviewing metrics and planning continuous improvement activities.\n* Set up analytics frameworks to track performance and engagement. Develop feedback loops, analytics tools, and engagement strategies for APIs.\n* API delivery doesn’t stop at launch. Without monitoring, teams can’t improve adoption, performance, or ROI. This station ensures APIs remain useful, secure, and evolving with business needs.\n\nh3. Other related resources\n* *API Metrics And Analytics*: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n* *API Community Engagement Strategies*: A playbook for fostering API adoption by cultivating communities through content, support channels, feedback loops, and social engagement strategies."
      },
      {
        "id": "integration-productization-cycle:question-template-markdown",
        "cycleId": "integration-productization-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Integration Productization Cycle question template Markdown",
        "body": "# Integration Productization Cycle question template\n\nA cycle for productizing reusable integration capabilities before selecting the implementation style.\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. Integration Capability Strategy\n\nFrame the reusable integration capability, business need, ownership, and expected reuse before selecting the implementation style.\n\n### Canvas questions\n#### Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n- **Persona**: Who is the typical customer experiencing this journey?\n- **Customer Discovers Need**: How does the customer recognize their need or problem?\n- **Customer Need Is Resolved**: How is the customer's need ultimately resolved?\n- **Journey Steps**: What are the steps the customer takes in their journey?\n- **Pains**: What are the customer's pain points or challenges?\n- **Gains**: What are the customer's gains or benefits?\n- **Inputs & Outputs**: What are the inputs and outputs at each step?\n- **Interaction & Processing Rules**: What are the interaction and processing rules at each step?\n\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Capability Value Proposition Canvas\nWhich reusable capability would create value for consumers without deciding yet whether it should be delivered as an API, event, file, stream, data product, or another implementation style?\n- **Consumer tasks and outcomes**: What are consumers, partners, users, systems, or teams trying to achieve?\n- **Gain-enabling capability features**: What capability features would help consumers achieve better outcomes, speed, automation, insight, reach, or compliance?\n- **Pain-relieving capability features**: What capability features would remove friction, manual work, errors, delays, risk, or uncertainty for consumers?\n- **Reusable capabilities**: What reusable business or data capabilities could serve these tasks, gains, and pains across more than one consumer or use case?\n\n#### Capability Business Model Canvas\nHow viable, reusable, funded, owned, supported, and discoverable should this integration capability be?\n- **Capability value proposition**: What value does this reusable capability provide to consumers and to the organization or ecosystem?\n- **Capability consumer segments**: Who are the current and potential consumers of the capability, including teams, partners, systems, products, or data users?\n- **Consumer engagement**: How will consumers discover, evaluate, request, onboard, get support for, and provide feedback on the capability?\n- **Channels**: Through which catalogs, portals, marketplaces, documentation sites, support paths, or governance processes will consumers interact with the capability?\n- **Key resources**: Which systems, data assets, platforms, people, standards, funding, and operational capabilities are required?\n- **Key activities**: What must the capability owner and producers do to design, deliver, govern, support, and improve the capability?\n- **Key partners**: Which business, technology, data, security, legal, platform, or external partners are needed to make the capability work?\n- **Benefits**: What business, operational, ecosystem, reuse, compliance, or cost benefits justify the capability?\n- **Costs**: What are the significant costs of building, operating, governing, supporting, and evolving the capability?\n\n## 2. Integration Consumer Requirements & Onboarding\n\nCapture integration consumers, provider responsibilities, onboarding needs, service expectations, and operational constraints.\n\n### Canvas questions\n#### Consumer Experience Requirements Canvas\nWhat experience and non-functional requirements do consumers need before deciding the best integration architecture?\n- **Consumer goals**: What are the consumer's business goals, workflow goals, decision goals, automation goals, or data usage goals?\n- **Availability and timeliness**: When must the capability be available, how fresh must information be, and what latency or delivery windows matter?\n- **Volume and performance**: What request, event, record, file, batch, user, or transaction volumes must the capability support now and later?\n- **Data quality and consistency**: What accuracy, completeness, consistency, ordering, deduplication, reconciliation, or validation expectations do consumers have?\n- **Security, privacy, and compliance**: What identity, authorization, confidentiality, residency, consent, retention, audit, or regulatory constraints apply?\n- **Onboarding and access**: How should consumers find, request, test, get approved for, and start using the capability?\n- **Change and versioning**: How much change tolerance do consumers have, and what notice, compatibility, migration, or versioning expectations apply?\n- **Observability and support**: What monitoring, status, traceability, data quality visibility, support, ownership, and incident communication do consumers need?\n- **Recovery and continuity**: What replay, retry, reconciliation, backup, fallback, continuity, or manual recovery expectations must be supported?\n- **Architecture implications**: What do these requirements imply for possible architecture styles, such as APIs, events, files, streams, data products, or direct integration?\n\n### Other related resources\n- **API Onboarding Best Practices**: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n\n## 3. Integration Architecture & Platform Decisions\n\nSelect the integration architecture, implementation style, and platform capabilities, taking account of constraints and the governance model.\n\n### Canvas questions\n#### Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n- **Availability Risks**: What are the potential risks to capability availability?\n- **Mitigate Availability Risks**: How can the capability owner mitigate the availability risks?\n- **Security Risks**: What are the potential security risks associated with the capability?\n- **Mitigate Security Risks**: How can the capability owner mitigate the security risks?\n- **Data Risks**: What are the potential risks to data integrity or confidentiality?\n- **Mitigate Data Risks**: How can the capability owner mitigate the data risks?\n\n#### Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n- **Location / Trust Groups**: What are the relevant geopolitical, regulatory, network, or trust groups?\n- **Group Characteristics**: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n- **Relevant Locations / Zones**: What are the relevant locations, zones, or environments within each group?\n- **Location / Zone Characteristics**: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n- **Network / Regulatory Distances**: What latency, trust, regulatory, or connectivity distances exist between the locations?\n- **Distance Characteristics**: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n- **Connectivity Endpoints**: What connectivity endpoints or interfaces are associated with the locations?\n- **Endpoint Access Characteristics**: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\n#### Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n- **Current Business Volumes**: What are the current business volumes and transaction rates?\n- **Future Consumption Trends**: What are the anticipated future consumption trends?\n- **Peak Load and Availability Requirements**: What are the peak load and availability requirements?\n- **Caching Strategies**: What caching strategies can be used to optimize performance?\n- **Rate Limiting Strategies**: What rate limiting strategies can be used to manage consumption?\n- **Scaling Strategies**: What scaling strategies can be used to accommodate growth?\n\n### Other related resources\n- **Partner Integration Guidelines**: Integration checklists and communication patterns to manage technical and legal aspects of third-party API relationships.\n\n## 4. Integration Solution Design\n\nDesign the interface contract, schemas, payloads, and interaction patterns for the selected integration style.\n\n### Canvas questions\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n- **CRUD Interactions**: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n- **CRUD Input & Output Models**: What are the input and output models for the CRUD interactions, if this style is needed?\n- **CRUD Processing & Validation**: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n- **Query-Driven Interactions**: What read or query interactions are needed to answer consumer questions?\n- **Query-Driven Input & Output Models**: What are the input and output models for the query-driven interactions?\n- **Query-Driven Processing & Validation**: What are the processing and validation rules for the query-driven interactions?\n- **Command-Driven Interactions**: What state-changing commands are needed, if any?\n- **Command-Driven Input & Output Models**: What are the input and output models for the command-driven interactions, if this style is needed?\n- **Command-Driven Processing & Validation**: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n- **Event-Driven Interactions**: What events need to be published or consumed, if any?\n- **Event-Driven Input & Output Models**: What are the input and output models for the event-driven interactions, if this style is needed?\n- **Event-Driven Processing & Validation**: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\n#### REST Canvas\nHow can the API be designed using RESTful principles?\n- **API Resources**: What are the key resources exposed by the API?\n- **API Resource Model**: What is the structure of the API resource model?\n- **API Verbs**: What HTTP verbs are used to interact with the API resources?\n- **API Verb Example**: Provide an example of an API request and response for each verb.\n\n#### Event Canvas\nWhat events are relevant to the API, and how are they processed?\n- **User Task / Trigger**: What user action or system event triggers this event operation?\n- **Input / Event Payload**: What data is included in the incoming event payload? Specify key attributes.\n- **Processing / Logic**: Describe the backend processing logic, including validations, transformations, or routing decisions.\n- **Output / Event Result**: What resulting event or acknowledgment is produced? Include attributes of the output payload.\n\n#### GraphQL Canvas\nHow can the API be designed using GraphQL principles?\n- **API Name**: What is the name of the GraphQL API or endpoint?\n- **Consumer Goals**: What problems are API consumers trying to solve? What data do they need?\n- **Key Types**: What are the core types exposed (e.g., User, Order, Product)?\n- **Relationships**: How do types relate to each other in nested queries?\n- **Queries**: What common queries should be supported?\n- **Mutations**: What operations will modify data (e.g., create, update, delete)?\n- **Subscriptions**: Are there any real-time updates or events consumers can subscribe to?\n- **Authorization Rules**: Who can access which fields or types?\n- **Consumer Constraints**: Are there pagination, filtering, or rate-limiting constraints?\n- **Notes / Open Questions**: Any pending decisions or integration considerations?\n\n### Other related resources\n- **Integration Style Selection Guide**: Guidance for choosing between API, event, file, stream, data product, direct integration, or hybrid implementation styles based on requirements and constraints.\n- **Contract First Design**: A guideline advocating for API-first approaches using formal contracts (e.g., OpenAPI) to align stakeholders before development.\n\n## 5. Integration Delivery & Operations\n\nBuild, test, automate, deploy, and operate the integration capability using its selected implementation style and validated interface contract.\n\n### Station questions\n- Use development best practices to implement the validated interface contract with established frameworks, libraries, and team standards.\n- Build the implementation from the validated interface contract using established frameworks, libraries, and team standards.\n- Use testing guidance to verify functionality, data quality, compatibility, security, performance, resilience, and recovery expectations.\n- Use CI/CD guidance to automate build, test, deployment, configuration, and traceability.\n- Use security guidance to protect data, access, credentials, and platform boundaries.\n- Use the audit checklist to ensure the solution meets functional and non-functional requirements, including security, performance, and compliance.\n- Apply delivery, testing, CI/CD, operations, and security guidance to the chosen implementation style.\n- A reusable capability needs reliable delivery and operations regardless of whether it becomes an API, event stream, file exchange, data product, or direct integration.\n\n### Other related resources\n- **API Development Best Practices**: Implementation guidance for turning a validated API interface contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.\n- **API Testing Best Practices**: Guidelines for implementing automated functional, performance, and security testing throughout the API lifecycle.\n- **APIOps CI/CD For APIs**: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n- **API Security Best Practices**: A set of actionable controls for securing APIs, including authentication, authorization, encryption, rate-limiting, and pipeline-level compliance checks.\n- **Partner Integration Guidelines**: Integration checklists and communication patterns to manage technical and legal aspects of third-party API relationships.\n\n## 6. Integration Readiness Assurance\n\nAssure integration readiness, governance, quality, security, compliance, and operational evidence before release.\n\n### Station questions\n- Use the audit checklist as a reusable quality checklist for interface contract, documentation, security, performance, and compliance readiness.\n- Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n- Collaborate with governance teams and domain experts to ensure the capability is ready for production.\n- Use audit and compliance resources to verify that the capability is ready for controlled release and reuse.\n- Reusable capabilities create operational, data, security, privacy, compliance, and consumer-impact risks. Readiness checks reduce surprises before release or production use.\n\n### Other related resources\n- **API Audit Checklist**: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n- **API Compliance Best Practices**: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\n## 7. Integration Publishing & Enablement\n\nPublish the integration capability so teams can discover it, evaluate it, request access, complete onboarding, reuse it, and get support.\n\n### Station questions\n- Publish capability information to the appropriate catalogs, portals, gateways, or environments to support reuse by multiple consumers.\n- Document how consumers find and use the capability, including onboarding processes and registration.\n- Ensure security models, access configuration, and legal terms are clear and accessible to consumers.\n- Publish ownership, documentation, onboarding, support contacts, service expectations, lifecycle status, and access request paths.\n- Reusable capabilities only create value when consumers can find them, understand their interface contract and service expectations, request access, and know who owns support and lifecycle decisions.\n\n### Other related resources\n- **API Onboarding Best Practices**: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n- **Service Agreement Template**: A customizable agreement format that defines expectations, SLAs, responsibilities, and access terms for API consumption.\n\n## 8. Integration Monitoring & Improvement\n\nMonitor integration reliability, reuse, incidents, performance, consumer outcomes, and improvement needs.\n\n### Station questions\n- Use metrics and analytics guidance to define capability usage, reliability, data quality, cost, adoption, and consumer-value measures.\n- Analyze usage metrics and incorporate consumer feedback into capability iterations.\n- Establish a habit of reviewing metrics and planning continuous improvement activities.\n- Use metrics, analytics, and engagement practices to improve the capability over time.\n- Capabilities need continuous feedback to stay reliable, valuable, cost-effective, and reusable as consumers, systems, data, and platforms change.\n\n### Other related resources\n- **API Metrics And Analytics**: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n- **API Community Engagement Strategies**: A playbook for fostering API adoption by cultivating communities through content, support channels, feedback loops, and social engagement strategies."
      },
      {
        "id": "integration-productization-cycle:question-template-confluence-wiki",
        "cycleId": "integration-productization-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Integration Productization Cycle question template Confluence wiki",
        "body": "h1. Integration Productization Cycle question template\n\nA cycle for productizing reusable integration capabilities before selecting the implementation style.\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. Integration Capability Strategy\n\nFrame the reusable integration capability, business need, ownership, and expected reuse before selecting the implementation style.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n* *Persona*: Who is the typical customer experiencing this journey?\n* *Customer Discovers Need*: How does the customer recognize their need or problem?\n* *Customer Need Is Resolved*: How is the customer's need ultimately resolved?\n* *Journey Steps*: What are the steps the customer takes in their journey?\n* *Pains*: What are the customer's pain points or challenges?\n* *Gains*: What are the customer's gains or benefits?\n* *Inputs & Outputs*: What are the inputs and outputs at each step?\n* *Interaction & Processing Rules*: What are the interaction and processing rules at each step?\n\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Capability Value Proposition Canvas\nWhich reusable capability would create value for consumers without deciding yet whether it should be delivered as an API, event, file, stream, data product, or another implementation style?\n* *Consumer tasks and outcomes*: What are consumers, partners, users, systems, or teams trying to achieve?\n* *Gain-enabling capability features*: What capability features would help consumers achieve better outcomes, speed, automation, insight, reach, or compliance?\n* *Pain-relieving capability features*: What capability features would remove friction, manual work, errors, delays, risk, or uncertainty for consumers?\n* *Reusable capabilities*: What reusable business or data capabilities could serve these tasks, gains, and pains across more than one consumer or use case?\n\nh4. Capability Business Model Canvas\nHow viable, reusable, funded, owned, supported, and discoverable should this integration capability be?\n* *Capability value proposition*: What value does this reusable capability provide to consumers and to the organization or ecosystem?\n* *Capability consumer segments*: Who are the current and potential consumers of the capability, including teams, partners, systems, products, or data users?\n* *Consumer engagement*: How will consumers discover, evaluate, request, onboard, get support for, and provide feedback on the capability?\n* *Channels*: Through which catalogs, portals, marketplaces, documentation sites, support paths, or governance processes will consumers interact with the capability?\n* *Key resources*: Which systems, data assets, platforms, people, standards, funding, and operational capabilities are required?\n* *Key activities*: What must the capability owner and producers do to design, deliver, govern, support, and improve the capability?\n* *Key partners*: Which business, technology, data, security, legal, platform, or external partners are needed to make the capability work?\n* *Benefits*: What business, operational, ecosystem, reuse, compliance, or cost benefits justify the capability?\n* *Costs*: What are the significant costs of building, operating, governing, supporting, and evolving the capability?\n\nh2. 2. Integration Consumer Requirements & Onboarding\n\nCapture integration consumers, provider responsibilities, onboarding needs, service expectations, and operational constraints.\n\nh3. Canvas questions\nh4. Consumer Experience Requirements Canvas\nWhat experience and non-functional requirements do consumers need before deciding the best integration architecture?\n* *Consumer goals*: What are the consumer's business goals, workflow goals, decision goals, automation goals, or data usage goals?\n* *Availability and timeliness*: When must the capability be available, how fresh must information be, and what latency or delivery windows matter?\n* *Volume and performance*: What request, event, record, file, batch, user, or transaction volumes must the capability support now and later?\n* *Data quality and consistency*: What accuracy, completeness, consistency, ordering, deduplication, reconciliation, or validation expectations do consumers have?\n* *Security, privacy, and compliance*: What identity, authorization, confidentiality, residency, consent, retention, audit, or regulatory constraints apply?\n* *Onboarding and access*: How should consumers find, request, test, get approved for, and start using the capability?\n* *Change and versioning*: How much change tolerance do consumers have, and what notice, compatibility, migration, or versioning expectations apply?\n* *Observability and support*: What monitoring, status, traceability, data quality visibility, support, ownership, and incident communication do consumers need?\n* *Recovery and continuity*: What replay, retry, reconciliation, backup, fallback, continuity, or manual recovery expectations must be supported?\n* *Architecture implications*: What do these requirements imply for possible architecture styles, such as APIs, events, files, streams, data products, or direct integration?\n\nh3. Other related resources\n* *API Onboarding Best Practices*: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n\nh2. 3. Integration Architecture & Platform Decisions\n\nSelect the integration architecture, implementation style, and platform capabilities, taking account of constraints and the governance model.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n* *Availability Risks*: What are the potential risks to capability availability?\n* *Mitigate Availability Risks*: How can the capability owner mitigate the availability risks?\n* *Security Risks*: What are the potential security risks associated with the capability?\n* *Mitigate Security Risks*: How can the capability owner mitigate the security risks?\n* *Data Risks*: What are the potential risks to data integrity or confidentiality?\n* *Mitigate Data Risks*: How can the capability owner mitigate the data risks?\n\nh4. Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n* *Location / Trust Groups*: What are the relevant geopolitical, regulatory, network, or trust groups?\n* *Group Characteristics*: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n* *Relevant Locations / Zones*: What are the relevant locations, zones, or environments within each group?\n* *Location / Zone Characteristics*: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n* *Network / Regulatory Distances*: What latency, trust, regulatory, or connectivity distances exist between the locations?\n* *Distance Characteristics*: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n* *Connectivity Endpoints*: What connectivity endpoints or interfaces are associated with the locations?\n* *Endpoint Access Characteristics*: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\nh4. Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n* *Current Business Volumes*: What are the current business volumes and transaction rates?\n* *Future Consumption Trends*: What are the anticipated future consumption trends?\n* *Peak Load and Availability Requirements*: What are the peak load and availability requirements?\n* *Caching Strategies*: What caching strategies can be used to optimize performance?\n* *Rate Limiting Strategies*: What rate limiting strategies can be used to manage consumption?\n* *Scaling Strategies*: What scaling strategies can be used to accommodate growth?\n\nh3. Other related resources\n* *Partner Integration Guidelines*: Integration checklists and communication patterns to manage technical and legal aspects of third-party API relationships.\n\nh2. 4. Integration Solution Design\n\nDesign the interface contract, schemas, payloads, and interaction patterns for the selected integration style.\n\nh3. Canvas questions\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n* *CRUD Interactions*: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n* *CRUD Input & Output Models*: What are the input and output models for the CRUD interactions, if this style is needed?\n* *CRUD Processing & Validation*: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n* *Query-Driven Interactions*: What read or query interactions are needed to answer consumer questions?\n* *Query-Driven Input & Output Models*: What are the input and output models for the query-driven interactions?\n* *Query-Driven Processing & Validation*: What are the processing and validation rules for the query-driven interactions?\n* *Command-Driven Interactions*: What state-changing commands are needed, if any?\n* *Command-Driven Input & Output Models*: What are the input and output models for the command-driven interactions, if this style is needed?\n* *Command-Driven Processing & Validation*: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n* *Event-Driven Interactions*: What events need to be published or consumed, if any?\n* *Event-Driven Input & Output Models*: What are the input and output models for the event-driven interactions, if this style is needed?\n* *Event-Driven Processing & Validation*: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\nh4. REST Canvas\nHow can the API be designed using RESTful principles?\n* *API Resources*: What are the key resources exposed by the API?\n* *API Resource Model*: What is the structure of the API resource model?\n* *API Verbs*: What HTTP verbs are used to interact with the API resources?\n* *API Verb Example*: Provide an example of an API request and response for each verb.\n\nh4. Event Canvas\nWhat events are relevant to the API, and how are they processed?\n* *User Task / Trigger*: What user action or system event triggers this event operation?\n* *Input / Event Payload*: What data is included in the incoming event payload? Specify key attributes.\n* *Processing / Logic*: Describe the backend processing logic, including validations, transformations, or routing decisions.\n* *Output / Event Result*: What resulting event or acknowledgment is produced? Include attributes of the output payload.\n\nh4. GraphQL Canvas\nHow can the API be designed using GraphQL principles?\n* *API Name*: What is the name of the GraphQL API or endpoint?\n* *Consumer Goals*: What problems are API consumers trying to solve? What data do they need?\n* *Key Types*: What are the core types exposed (e.g., User, Order, Product)?\n* *Relationships*: How do types relate to each other in nested queries?\n* *Queries*: What common queries should be supported?\n* *Mutations*: What operations will modify data (e.g., create, update, delete)?\n* *Subscriptions*: Are there any real-time updates or events consumers can subscribe to?\n* *Authorization Rules*: Who can access which fields or types?\n* *Consumer Constraints*: Are there pagination, filtering, or rate-limiting constraints?\n* *Notes / Open Questions*: Any pending decisions or integration considerations?\n\nh3. Other related resources\n* *Integration Style Selection Guide*: Guidance for choosing between API, event, file, stream, data product, direct integration, or hybrid implementation styles based on requirements and constraints.\n* *Contract First Design*: A guideline advocating for API-first approaches using formal contracts (e.g., OpenAPI) to align stakeholders before development.\n\nh2. 5. Integration Delivery & Operations\n\nBuild, test, automate, deploy, and operate the integration capability using its selected implementation style and validated interface contract.\n\nh3. Station questions\n* Use development best practices to implement the validated interface contract with established frameworks, libraries, and team standards.\n* Build the implementation from the validated interface contract using established frameworks, libraries, and team standards.\n* Use testing guidance to verify functionality, data quality, compatibility, security, performance, resilience, and recovery expectations.\n* Use CI/CD guidance to automate build, test, deployment, configuration, and traceability.\n* Use security guidance to protect data, access, credentials, and platform boundaries.\n* Use the audit checklist to ensure the solution meets functional and non-functional requirements, including security, performance, and compliance.\n* Apply delivery, testing, CI/CD, operations, and security guidance to the chosen implementation style.\n* A reusable capability needs reliable delivery and operations regardless of whether it becomes an API, event stream, file exchange, data product, or direct integration.\n\nh3. Other related resources\n* *API Development Best Practices*: Implementation guidance for turning a validated API interface contract into a consistent, maintainable API codebase using standard libraries, reusable patterns, and aligned development workflows.\n* *API Testing Best Practices*: Guidelines for implementing automated functional, performance, and security testing throughout the API lifecycle.\n* *APIOps CI/CD For APIs*: Deployment guidance that integrates API lifecycle tasks—design, testing, governance—into continuous integration and delivery pipelines.\n* *API Security Best Practices*: A set of actionable controls for securing APIs, including authentication, authorization, encryption, rate-limiting, and pipeline-level compliance checks.\n* *Partner Integration Guidelines*: Integration checklists and communication patterns to manage technical and legal aspects of third-party API relationships.\n\nh2. 6. Integration Readiness Assurance\n\nAssure integration readiness, governance, quality, security, compliance, and operational evidence before release.\n\nh3. Station questions\n* Use the audit checklist as a reusable quality checklist for interface contract, documentation, security, performance, and compliance readiness.\n* Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n* Collaborate with governance teams and domain experts to ensure the capability is ready for production.\n* Use audit and compliance resources to verify that the capability is ready for controlled release and reuse.\n* Reusable capabilities create operational, data, security, privacy, compliance, and consumer-impact risks. Readiness checks reduce surprises before release or production use.\n\nh3. Other related resources\n* *API Audit Checklist*: A lifecycle-based checklist to verify API readiness across design, delivery, publishing, and compliance using defined audit criteria and evidence.\n* *API Compliance Best Practices*: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\nh2. 7. Integration Publishing & Enablement\n\nPublish the integration capability so teams can discover it, evaluate it, request access, complete onboarding, reuse it, and get support.\n\nh3. Station questions\n* Publish capability information to the appropriate catalogs, portals, gateways, or environments to support reuse by multiple consumers.\n* Document how consumers find and use the capability, including onboarding processes and registration.\n* Ensure security models, access configuration, and legal terms are clear and accessible to consumers.\n* Publish ownership, documentation, onboarding, support contacts, service expectations, lifecycle status, and access request paths.\n* Reusable capabilities only create value when consumers can find them, understand their interface contract and service expectations, request access, and know who owns support and lifecycle decisions.\n\nh3. Other related resources\n* *API Onboarding Best Practices*: Best practices to streamline API consumer onboarding journeys with step-by-step registration, discovery, and first-call guidance.\n* *Service Agreement Template*: A customizable agreement format that defines expectations, SLAs, responsibilities, and access terms for API consumption.\n\nh2. 8. Integration Monitoring & Improvement\n\nMonitor integration reliability, reuse, incidents, performance, consumer outcomes, and improvement needs.\n\nh3. Station questions\n* Use metrics and analytics guidance to define capability usage, reliability, data quality, cost, adoption, and consumer-value measures.\n* Analyze usage metrics and incorporate consumer feedback into capability iterations.\n* Establish a habit of reviewing metrics and planning continuous improvement activities.\n* Use metrics, analytics, and engagement practices to improve the capability over time.\n* Capabilities need continuous feedback to stay reliable, valuable, cost-effective, and reusable as consumers, systems, data, and platforms change.\n\nh3. Other related resources\n* *API Metrics And Analytics*: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes.\n* *API Community Engagement Strategies*: A playbook for fostering API adoption by cultivating communities through content, support channels, feedback loops, and social engagement strategies."
      },
      {
        "id": "automation-cycle:question-template-markdown",
        "cycleId": "automation-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Automation Cycle question template Markdown",
        "body": "# Automation Cycle question template\n\nA cycle for identifying, designing, delivering, enabling, and improving automation opportunities.\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. Automation Opportunity Strategy\n\nIdentify and prioritize automation opportunities by value, feasibility, risk, ownership, and expected process impact.\n\n### Canvas questions\n#### Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n- **Persona**: Who is the typical customer experiencing this journey?\n- **Customer Discovers Need**: How does the customer recognize their need or problem?\n- **Customer Need Is Resolved**: How is the customer's need ultimately resolved?\n- **Journey Steps**: What are the steps the customer takes in their journey?\n- **Pains**: What are the customer's pain points or challenges?\n- **Gains**: What are the customer's gains or benefits?\n- **Inputs & Outputs**: What are the inputs and outputs at each step?\n- **Interaction & Processing Rules**: What are the interaction and processing rules at each step?\n\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Capability Value Proposition Canvas\nWhich reusable capability would create value for consumers without deciding yet whether it should be delivered as an API, event, file, stream, data product, or another implementation style?\n- **Consumer tasks and outcomes**: What are consumers, partners, users, systems, or teams trying to achieve?\n- **Gain-enabling capability features**: What capability features would help consumers achieve better outcomes, speed, automation, insight, reach, or compliance?\n- **Pain-relieving capability features**: What capability features would remove friction, manual work, errors, delays, risk, or uncertainty for consumers?\n- **Reusable capabilities**: What reusable business or data capabilities could serve these tasks, gains, and pains across more than one consumer or use case?\n\n## 2. Process & User Requirements\n\nCapture process users, roles, handoffs, exceptions, constraints, and service expectations before designing the automation.\n\n### Canvas questions\n#### Consumer Experience Requirements Canvas\nWhat experience and non-functional requirements do consumers need before deciding the best integration architecture?\n- **Consumer goals**: What are the consumer's business goals, workflow goals, decision goals, automation goals, or data usage goals?\n- **Availability and timeliness**: When must the capability be available, how fresh must information be, and what latency or delivery windows matter?\n- **Volume and performance**: What request, event, record, file, batch, user, or transaction volumes must the capability support now and later?\n- **Data quality and consistency**: What accuracy, completeness, consistency, ordering, deduplication, reconciliation, or validation expectations do consumers have?\n- **Security, privacy, and compliance**: What identity, authorization, confidentiality, residency, consent, retention, audit, or regulatory constraints apply?\n- **Onboarding and access**: How should consumers find, request, test, get approved for, and start using the capability?\n- **Change and versioning**: How much change tolerance do consumers have, and what notice, compatibility, migration, or versioning expectations apply?\n- **Observability and support**: What monitoring, status, traceability, data quality visibility, support, ownership, and incident communication do consumers need?\n- **Recovery and continuity**: What replay, retry, reconciliation, backup, fallback, continuity, or manual recovery expectations must be supported?\n- **Architecture implications**: What do these requirements imply for possible architecture styles, such as APIs, events, files, streams, data products, or direct integration?\n\n## 3. Automation Platform Decision\n\nChoose the automation platform, runtime, integration approach, governance controls, and operating constraints.\n\n### Canvas questions\n#### Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n- **Availability Risks**: What are the potential risks to capability availability?\n- **Mitigate Availability Risks**: How can the capability owner mitigate the availability risks?\n- **Security Risks**: What are the potential security risks associated with the capability?\n- **Mitigate Security Risks**: How can the capability owner mitigate the security risks?\n- **Data Risks**: What are the potential risks to data integrity or confidentiality?\n- **Mitigate Data Risks**: How can the capability owner mitigate the data risks?\n\n#### Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n- **Location / Trust Groups**: What are the relevant geopolitical, regulatory, network, or trust groups?\n- **Group Characteristics**: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n- **Relevant Locations / Zones**: What are the relevant locations, zones, or environments within each group?\n- **Location / Zone Characteristics**: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n- **Network / Regulatory Distances**: What latency, trust, regulatory, or connectivity distances exist between the locations?\n- **Distance Characteristics**: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n- **Connectivity Endpoints**: What connectivity endpoints or interfaces are associated with the locations?\n- **Endpoint Access Characteristics**: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\n#### Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n- **Current Business Volumes**: What are the current business volumes and transaction rates?\n- **Future Consumption Trends**: What are the anticipated future consumption trends?\n- **Peak Load and Availability Requirements**: What are the peak load and availability requirements?\n- **Caching Strategies**: What caching strategies can be used to optimize performance?\n- **Rate Limiting Strategies**: What rate limiting strategies can be used to manage consumption?\n- **Scaling Strategies**: What scaling strategies can be used to accommodate growth?\n\n### Other related resources\n- **Automation Operational Ownership Guide**: Guidance for defining ownership, runbooks, supervision, support, monitoring, change control, and continuous improvement responsibilities for automations.\n\n## 4. Automation Workflow Design\n\nDesign the automation workflow, triggers, decision points, integrations, data handling, relevant interface contracts, and exception paths.\n\n### Canvas questions\n#### Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n- **Selected Customer Journey Steps**: Which customer journey steps are relevant to this domain?\n- **Core Entities & Business Meaning**: What are the core entities and their business meaning?\n- **Attributes & Business Importance**: What are the key attributes of each entity and their business importance?\n- **Relationships Between Entities**: What are the relationships between the entities?\n- **Business, Compliance & Integrity Rules**: What are the business, compliance, and integrity rules related to the entities?\n- **Security & Privacy Considerations**: What are the security and privacy considerations related to the entities?\n\n#### Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n- **CRUD Interactions**: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n- **CRUD Input & Output Models**: What are the input and output models for the CRUD interactions, if this style is needed?\n- **CRUD Processing & Validation**: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n- **Query-Driven Interactions**: What read or query interactions are needed to answer consumer questions?\n- **Query-Driven Input & Output Models**: What are the input and output models for the query-driven interactions?\n- **Query-Driven Processing & Validation**: What are the processing and validation rules for the query-driven interactions?\n- **Command-Driven Interactions**: What state-changing commands are needed, if any?\n- **Command-Driven Input & Output Models**: What are the input and output models for the command-driven interactions, if this style is needed?\n- **Command-Driven Processing & Validation**: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n- **Event-Driven Interactions**: What events need to be published or consumed, if any?\n- **Event-Driven Input & Output Models**: What are the input and output models for the event-driven interactions, if this style is needed?\n- **Event-Driven Processing & Validation**: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\n### Other related resources\n- **Process Workflow Design Guide**: Guidance for modeling the process steps, roles, handoffs, decision points, states, inputs, outputs, and exceptions that shape an automation workflow.\n- **Decision And Business Rules Guide**: Guidance for capturing rules, thresholds, decisions, approvals, eligibility checks, and rule ownership for automation design.\n- **Automation Trigger, Handoff And Exception Guide**: Guidance for defining automation triggers, human handoffs, exception handling, retries, compensating actions, and support escalation paths.\n\n## 5. Automation Delivery & Operations\n\nBuild, test, deploy, document, and operate the automation using clear ownership, controls, and rollback paths.\n\n### Station questions\n- Use development best practices to implement the validated interface contract with established frameworks, libraries, and team standards.\n- Build the implementation from the validated interface contract using established frameworks, libraries, and team standards.\n- Use testing guidance to verify functionality, data quality, compatibility, security, performance, resilience, and recovery expectations.\n- Use CI/CD guidance to automate build, test, deployment, configuration, and traceability.\n- Use security guidance to protect data, access, credentials, and platform boundaries.\n- Use the audit checklist to ensure the solution meets functional and non-functional requirements, including security, performance, and compliance.\n- Apply delivery, testing, CI/CD, operations, and security guidance to the chosen implementation style.\n- A reusable capability needs reliable delivery and operations regardless of whether it becomes an API, event stream, file exchange, data product, or direct integration.\n\n### Other related resources\n- **Automation Testing Guide**: Guidance for testing automated workflows, decisions, integrations, exceptions, rollback behavior, supervision, and user impact before release.\n- **Automation Operational Ownership Guide**: Guidance for defining ownership, runbooks, supervision, support, monitoring, change control, and continuous improvement responsibilities for automations.\n- **Automation Rollback And Supervision Guide**: Guidance for designing rollback, pause, manual override, monitoring, supervision, and recovery paths for automations.\n\n## 6. Automation Readiness Review\n\nReview automation readiness, quality, risk, compliance, human oversight, evidence, and release criteria.\n\n### Station questions\n- Use the audit checklist as a reusable quality checklist for interface contract, documentation, security, performance, and compliance readiness.\n- Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n- Collaborate with governance teams and domain experts to ensure the capability is ready for production.\n- Use audit and compliance resources to verify that the capability is ready for controlled release and reuse.\n- Reusable capabilities create operational, data, security, privacy, compliance, and consumer-impact risks. Readiness checks reduce surprises before release or production use.\n\n### Other related resources\n- **Automation Readiness Checklist**: A checklist for validating automation workflow, controls, risk, compliance, human oversight, testing evidence, rollback, operations, and release readiness.\n- **API Compliance Best Practices**: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\n## 7. Automation Rollout & Enablement\n\nRoll out the automation with discovery, onboarding, operating instructions, support paths, and change communication for users and operators.\n\n### Station questions\n- Publish capability information to the appropriate catalogs, portals, gateways, or environments to support reuse by multiple consumers.\n- Document how consumers find and use the capability, including onboarding processes and registration.\n- Ensure security models, access configuration, and legal terms are clear and accessible to consumers.\n- Publish ownership, documentation, onboarding, support contacts, service expectations, lifecycle status, and access request paths.\n- Reusable capabilities only create value when consumers can find them, understand their interface contract and service expectations, request access, and know who owns support and lifecycle decisions.\n\n### Other related resources\n- **Automation Rollout And Enablement Guide**: Guidance for rolling out automations with user communication, onboarding, operating instructions, support paths, change management, and feedback loops.\n- **Service Agreement Template**: A customizable agreement format that defines expectations, SLAs, responsibilities, and access terms for API consumption.\n\n## 8. Automation Monitoring & Improvement\n\nMonitor automation performance, exceptions, reliability, user outcomes, operational impact, and improvement opportunities.\n\n### Station questions\n- Use metrics and analytics guidance to define capability usage, reliability, data quality, cost, adoption, and consumer-value measures.\n- Analyze usage metrics and incorporate consumer feedback into capability iterations.\n- Establish a habit of reviewing metrics and planning continuous improvement activities.\n- Use metrics, analytics, and engagement practices to improve the capability over time.\n- Capabilities need continuous feedback to stay reliable, valuable, cost-effective, and reusable as consumers, systems, data, and platforms change.\n\n### Other related resources\n- **Automation Operational Ownership Guide**: Guidance for defining ownership, runbooks, supervision, support, monitoring, change control, and continuous improvement responsibilities for automations.\n- **API Metrics And Analytics**: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes."
      },
      {
        "id": "automation-cycle:question-template-confluence-wiki",
        "cycleId": "automation-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Automation Cycle question template Confluence wiki",
        "body": "h1. Automation Cycle question template\n\nA cycle for identifying, designing, delivering, enabling, and improving automation opportunities.\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. Automation Opportunity Strategy\n\nIdentify and prioritize automation opportunities by value, feasibility, risk, ownership, and expected process impact.\n\nh3. Canvas questions\nh4. Customer Journey Canvas\nWhat customer, partner, or consumer journey is the capability intended to support?\n* *Persona*: Who is the typical customer experiencing this journey?\n* *Customer Discovers Need*: How does the customer recognize their need or problem?\n* *Customer Need Is Resolved*: How is the customer's need ultimately resolved?\n* *Journey Steps*: What are the steps the customer takes in their journey?\n* *Pains*: What are the customer's pain points or challenges?\n* *Gains*: What are the customer's gains or benefits?\n* *Inputs & Outputs*: What are the inputs and outputs at each step?\n* *Interaction & Processing Rules*: What are the interaction and processing rules at each step?\n\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Capability Value Proposition Canvas\nWhich reusable capability would create value for consumers without deciding yet whether it should be delivered as an API, event, file, stream, data product, or another implementation style?\n* *Consumer tasks and outcomes*: What are consumers, partners, users, systems, or teams trying to achieve?\n* *Gain-enabling capability features*: What capability features would help consumers achieve better outcomes, speed, automation, insight, reach, or compliance?\n* *Pain-relieving capability features*: What capability features would remove friction, manual work, errors, delays, risk, or uncertainty for consumers?\n* *Reusable capabilities*: What reusable business or data capabilities could serve these tasks, gains, and pains across more than one consumer or use case?\n\nh2. 2. Process & User Requirements\n\nCapture process users, roles, handoffs, exceptions, constraints, and service expectations before designing the automation.\n\nh3. Canvas questions\nh4. Consumer Experience Requirements Canvas\nWhat experience and non-functional requirements do consumers need before deciding the best integration architecture?\n* *Consumer goals*: What are the consumer's business goals, workflow goals, decision goals, automation goals, or data usage goals?\n* *Availability and timeliness*: When must the capability be available, how fresh must information be, and what latency or delivery windows matter?\n* *Volume and performance*: What request, event, record, file, batch, user, or transaction volumes must the capability support now and later?\n* *Data quality and consistency*: What accuracy, completeness, consistency, ordering, deduplication, reconciliation, or validation expectations do consumers have?\n* *Security, privacy, and compliance*: What identity, authorization, confidentiality, residency, consent, retention, audit, or regulatory constraints apply?\n* *Onboarding and access*: How should consumers find, request, test, get approved for, and start using the capability?\n* *Change and versioning*: How much change tolerance do consumers have, and what notice, compatibility, migration, or versioning expectations apply?\n* *Observability and support*: What monitoring, status, traceability, data quality visibility, support, ownership, and incident communication do consumers need?\n* *Recovery and continuity*: What replay, retry, reconciliation, backup, fallback, continuity, or manual recovery expectations must be supported?\n* *Architecture implications*: What do these requirements imply for possible architecture styles, such as APIs, events, files, streams, data products, or direct integration?\n\nh2. 3. Automation Platform Decision\n\nChoose the automation platform, runtime, integration approach, governance controls, and operating constraints.\n\nh3. Canvas questions\nh4. Business Impact Canvas\nWhat are the potential business impacts if the capability, integration, or service fails?\n* *Availability Risks*: What are the potential risks to capability availability?\n* *Mitigate Availability Risks*: How can the capability owner mitigate the availability risks?\n* *Security Risks*: What are the potential security risks associated with the capability?\n* *Mitigate Security Risks*: How can the capability owner mitigate the security risks?\n* *Data Risks*: What are the potential risks to data integrity or confidentiality?\n* *Mitigate Data Risks*: How can the capability owner mitigate the data risks?\n\nh4. Location Canvas\nWhat geopolitical, regulatory, network, and trust boundaries affect this capability or integration?\n* *Location / Trust Groups*: What are the relevant geopolitical, regulatory, network, or trust groups?\n* *Group Characteristics*: What are the characteristics of those groups, such as residency, trust level, or network exposure?\n* *Relevant Locations / Zones*: What are the relevant locations, zones, or environments within each group?\n* *Location / Zone Characteristics*: What are the characteristics of those locations or zones, such as ownership, region, or exposure?\n* *Network / Regulatory Distances*: What latency, trust, regulatory, or connectivity distances exist between the locations?\n* *Distance Characteristics*: What are the characteristics of those distances, such as latency sensitivity, residency constraints, or trust boundaries?\n* *Connectivity Endpoints*: What connectivity endpoints or interfaces are associated with the locations?\n* *Endpoint Access Characteristics*: What are the characteristics of those endpoints, such as exposure, protocol, security, or access restrictions?\n\nh4. Capacity Canvas\nHow much capacity is needed to support expected capability consumption?\n* *Current Business Volumes*: What are the current business volumes and transaction rates?\n* *Future Consumption Trends*: What are the anticipated future consumption trends?\n* *Peak Load and Availability Requirements*: What are the peak load and availability requirements?\n* *Caching Strategies*: What caching strategies can be used to optimize performance?\n* *Rate Limiting Strategies*: What rate limiting strategies can be used to manage consumption?\n* *Scaling Strategies*: What scaling strategies can be used to accommodate growth?\n\nh3. Other related resources\n* *Automation Operational Ownership Guide*: Guidance for defining ownership, runbooks, supervision, support, monitoring, change control, and continuous improvement responsibilities for automations.\n\nh2. 4. Automation Workflow Design\n\nDesign the automation workflow, triggers, decision points, integrations, data handling, relevant interface contracts, and exception paths.\n\nh3. Canvas questions\nh4. Domain Canvas\nWhat are the core entities and business rules related to this capability or domain?\n* *Selected Customer Journey Steps*: Which customer journey steps are relevant to this domain?\n* *Core Entities & Business Meaning*: What are the core entities and their business meaning?\n* *Attributes & Business Importance*: What are the key attributes of each entity and their business importance?\n* *Relationships Between Entities*: What are the relationships between the entities?\n* *Business, Compliance & Integrity Rules*: What are the business, compliance, and integrity rules related to the entities?\n* *Security & Privacy Considerations*: What are the security and privacy considerations related to the entities?\n\nh4. Interaction Canvas\nWhat kinds of interactions should this capability support before choosing a protocol-specific design?\n* *CRUD Interactions*: Are CRUD (Create, Read, Update, Delete) interactions needed here?\n* *CRUD Input & Output Models*: What are the input and output models for the CRUD interactions, if this style is needed?\n* *CRUD Processing & Validation*: What are the processing and validation rules for the CRUD interactions, if this style is needed?\n* *Query-Driven Interactions*: What read or query interactions are needed to answer consumer questions?\n* *Query-Driven Input & Output Models*: What are the input and output models for the query-driven interactions?\n* *Query-Driven Processing & Validation*: What are the processing and validation rules for the query-driven interactions?\n* *Command-Driven Interactions*: What state-changing commands are needed, if any?\n* *Command-Driven Input & Output Models*: What are the input and output models for the command-driven interactions, if this style is needed?\n* *Command-Driven Processing & Validation*: What are the processing and validation rules for the command-driven interactions, if this style is needed?\n* *Event-Driven Interactions*: What events need to be published or consumed, if any?\n* *Event-Driven Input & Output Models*: What are the input and output models for the event-driven interactions, if this style is needed?\n* *Event-Driven Processing & Validation*: What are the processing and validation rules for the event-driven interactions, if this style is needed?\n\nh3. Other related resources\n* *Process Workflow Design Guide*: Guidance for modeling the process steps, roles, handoffs, decision points, states, inputs, outputs, and exceptions that shape an automation workflow.\n* *Decision And Business Rules Guide*: Guidance for capturing rules, thresholds, decisions, approvals, eligibility checks, and rule ownership for automation design.\n* *Automation Trigger, Handoff And Exception Guide*: Guidance for defining automation triggers, human handoffs, exception handling, retries, compensating actions, and support escalation paths.\n\nh2. 5. Automation Delivery & Operations\n\nBuild, test, deploy, document, and operate the automation using clear ownership, controls, and rollback paths.\n\nh3. Station questions\n* Use development best practices to implement the validated interface contract with established frameworks, libraries, and team standards.\n* Build the implementation from the validated interface contract using established frameworks, libraries, and team standards.\n* Use testing guidance to verify functionality, data quality, compatibility, security, performance, resilience, and recovery expectations.\n* Use CI/CD guidance to automate build, test, deployment, configuration, and traceability.\n* Use security guidance to protect data, access, credentials, and platform boundaries.\n* Use the audit checklist to ensure the solution meets functional and non-functional requirements, including security, performance, and compliance.\n* Apply delivery, testing, CI/CD, operations, and security guidance to the chosen implementation style.\n* A reusable capability needs reliable delivery and operations regardless of whether it becomes an API, event stream, file exchange, data product, or direct integration.\n\nh3. Other related resources\n* *Automation Testing Guide*: Guidance for testing automated workflows, decisions, integrations, exceptions, rollback behavior, supervision, and user impact before release.\n* *Automation Operational Ownership Guide*: Guidance for defining ownership, runbooks, supervision, support, monitoring, change control, and continuous improvement responsibilities for automations.\n* *Automation Rollback And Supervision Guide*: Guidance for designing rollback, pause, manual override, monitoring, supervision, and recovery paths for automations.\n\nh2. 6. Automation Readiness Review\n\nReview automation readiness, quality, risk, compliance, human oversight, evidence, and release criteria.\n\nh3. Station questions\n* Use the audit checklist as a reusable quality checklist for interface contract, documentation, security, performance, and compliance readiness.\n* Use checklists, linters, and testing tools to verify consistency and conformance with standards.\n* Collaborate with governance teams and domain experts to ensure the capability is ready for production.\n* Use audit and compliance resources to verify that the capability is ready for controlled release and reuse.\n* Reusable capabilities create operational, data, security, privacy, compliance, and consumer-impact risks. Readiness checks reduce surprises before release or production use.\n\nh3. Other related resources\n* *Automation Readiness Checklist*: A checklist for validating automation workflow, controls, risk, compliance, human oversight, testing evidence, rollback, operations, and release readiness.\n* *API Compliance Best Practices*: Ensure APIs meet legal, regulatory, and internal compliance through documentation, controls, and automated validations.\n\nh2. 7. Automation Rollout & Enablement\n\nRoll out the automation with discovery, onboarding, operating instructions, support paths, and change communication for users and operators.\n\nh3. Station questions\n* Publish capability information to the appropriate catalogs, portals, gateways, or environments to support reuse by multiple consumers.\n* Document how consumers find and use the capability, including onboarding processes and registration.\n* Ensure security models, access configuration, and legal terms are clear and accessible to consumers.\n* Publish ownership, documentation, onboarding, support contacts, service expectations, lifecycle status, and access request paths.\n* Reusable capabilities only create value when consumers can find them, understand their interface contract and service expectations, request access, and know who owns support and lifecycle decisions.\n\nh3. Other related resources\n* *Automation Rollout And Enablement Guide*: Guidance for rolling out automations with user communication, onboarding, operating instructions, support paths, change management, and feedback loops.\n* *Service Agreement Template*: A customizable agreement format that defines expectations, SLAs, responsibilities, and access terms for API consumption.\n\nh2. 8. Automation Monitoring & Improvement\n\nMonitor automation performance, exceptions, reliability, user outcomes, operational impact, and improvement opportunities.\n\nh3. Station questions\n* Use metrics and analytics guidance to define capability usage, reliability, data quality, cost, adoption, and consumer-value measures.\n* Analyze usage metrics and incorporate consumer feedback into capability iterations.\n* Establish a habit of reviewing metrics and planning continuous improvement activities.\n* Use metrics, analytics, and engagement practices to improve the capability over time.\n* Capabilities need continuous feedback to stay reliable, valuable, cost-effective, and reusable as consumers, systems, data, and platforms change.\n\nh3. Other related resources\n* *Automation Operational Ownership Guide*: Guidance for defining ownership, runbooks, supervision, support, monitoring, change control, and continuous improvement responsibilities for automations.\n* *API Metrics And Analytics*: A resource for defining, collecting, and analyzing API performance and usage data to align technical KPIs with business outcomes."
      }
    ]
  }
}