{
  "source": {
    "repository": "https://github.com/APIOpsCycles/apiops-cycles-method-data",
    "commit": "4418d7ccff492f591957f0e53fd9d476354041d7"
  },
  "locales": [
    "en",
    "fi",
    "fr",
    "de",
    "pt"
  ],
  "defaultLocale": "en",
  "translations": {
    "pt": [
      {
        "id": "capability-productization-cycle:question-template-markdown",
        "cycleId": "capability-productization-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Ciclo de Produto de Capacidades question template Markdown",
        "body": "# Ciclo de Produto de Capacidades question template\n\nUm ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.\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. Estrategia da capacidade\n\nAntes de construir qualquer coisa, defina o valor, os consumidores, a propriedade e os objetivos de negócio da capacidade.\n\n### Canvas questions\n#### Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n- **Persona**: Quem é o cliente típico que passa por esta percurso?\n- **O cliente descobre a necessidade**: Como o cliente reconhece sua necessidade ou problema?\n- **Necessidade do cliente resolvida**: Como a necessidade do cliente é resolvida no final?\n- **Etapas da percurso**: Quais são as etapas que o cliente percorre em sua percurso?\n- **Dores**: Quais são os pontos fracos ou desafios do cliente?\n- **Ganhos**: Quais são os ganhos ou benefícios do cliente?\n- **Entradas e saídas**: Quais são as entradas e saídas em cada etapa?\n- **Regras de interação e processamento**: Quais são as regras de interação e processamento em cada etapa?\n\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas da Proposta de Valor da Capacidade\nQue capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?\n- **Tarefas e resultados dos utilizadores**: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?\n- **Funcionalidades da capacidade que permitem ganhos**: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?\n- **Funcionalidades da capacidade que aliviam dores**: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?\n- **Capacidades reutilizáveis**: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?\n\n#### Canvas do Modelo de Negócio da Capacidade\nQuão viável, reutilizável, financiada, atribuída, apoiada e detetável deve ser esta capacidade de integração?\n- **Proposta de valor da capacidade**: Que valor esta capacidade reutilizável oferece aos utilizadores e à organização ou ecossistema?\n- **Segmentos de utilizadores da capacidade**: Quem são os utilizadores atuais e potenciais da capacidade, incluindo equipas, parceiros, sistemas, produtos ou utilizadores de dados?\n- **Envolvimento dos utilizadores**: Como irão os utilizadores descobrir, avaliar, solicitar, integrar-se, obter apoio e dar feedback sobre a capacidade?\n- **Canais**: Através de que catálogos, portais, marketplaces, sites de documentação, caminhos de apoio ou processos de governação os utilizadores irão interagir com a capacidade?\n- **Recursos-chave**: Que sistemas, ativos de dados, plataformas, pessoas, normas, financiamento e capacidades operacionais são necessários?\n- **Atividades-chave**: O que o responsável pela capacidade e os produtores devem fazer para conceber, entregar, governar, apoiar e melhorar a capacidade?\n- **Parceiros-chave**: Que parceiros de negócio, tecnologia, dados, segurança, jurídico, plataforma ou externos são necessários para que a capacidade funcione?\n- **Benefícios**: Que benefícios de negócio, operacionais, de ecossistema, reutilização, conformidade ou custo justificam a capacidade?\n- **Custos**: Quais são os custos significativos de construir, operar, governar, apoiar e evoluir a capacidade?\n\n## 2. Requisitos e onboarding de utilizadores\n\nRecolha requisitos de integração dos consumidores, normas, requisitos não funcionais, expectativas de serviço, restrições, necessidades de segurança, protocolos permitidos, atualidade dos dados, SLAs, observabilidade, recuperação, requisitos de adoção e responsabilidades dos produtores.\n\n### Canvas questions\n#### Canvas de Requisitos da Experiência do Utilizador\nQue requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?\n- **Objetivos dos utilizadores**: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?\n- **Disponibilidade e atualidade**: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?\n- **Volume e desempenho**: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?\n- **Qualidade e consistência dos dados**: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?\n- **Segurança, privacidade e conformidade**: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?\n- **Integração e acesso**: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?\n- **Mudança e controlo de versões**: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?\n- **Observabilidade e apoio**: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?\n- **Recuperação e continuidade**: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?\n- **Implicações de arquitetura**: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?\n\n### Other related resources\n- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n\n## 3. Decisões de arquitetura e plataforma\n\nUtilize requisitos e restrições para decidir o padrão de arquitetura certo e as capacidades de plataforma de suporte.\n\n### Canvas questions\n#### Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n- **Riscos de disponibilidade**: Quais são os riscos potenciais para a disponibilidade da API?\n- **Mitigar riscos de disponibilidade**: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n- **Riscos de segurança**: Quais são os riscos potenciais de segurança associados à API?\n- **Mitigar riscos de segurança**: Como o fornecedor da API pode mitigar os riscos de segurança?\n- **Riscos de dados**: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n- **Mitigar riscos de dados**: Como o fornecedor da API pode mitigar os riscos de dados?\n\n#### Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n- **Grupos de Localização / Confiança**: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n- **Características do grupo**: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n- **Locais / Zonas Relevantes**: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n- **Características de localização / zona**: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n- **Distâncias de Rede / Regulatórias**: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n- **Características da Distância**: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n- **Pontos de extremidade de conectividade**: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n- **Características de acesso aos pontos de extremidade**: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\n#### Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n- **Volumes de negócio atuais**: Quais são os volumes de negócio e as taxas de transação atuais?\n- **Tendências de consumo futuro**: Quais são as tendências de consumo futuro previstas?\n- **Requisitos de pico de carga e disponibilidade**: Quais são os requisitos de pico de carga e disponibilidade?\n- **Estratégias de cache**: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n- **Estratégias de limitação de pedidos**: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n- **Estratégias de dimensionamento**: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\n## 4. Conceção da solução e da interface\n\nConceba o contrato de interface e o modelo de interação para o estilo de disponibilização selecionado.\n\n### Canvas questions\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n- **Interações CRUD**: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n- **Modelos de entrada e saída CRUD**: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n- **Processamento e validação CRUD**: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n- **Interações orientadas por consulta**: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n- **Modelos de entrada e saída orientados por consulta**: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n- **Processamento e validação orientados por consulta**: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n- **Interações orientadas por comando**: Quais comandos de alteração de estado são necessários, se houver?\n- **Modelos de entrada e saída orientados por comando**: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Processamento e validação orientados por comando**: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Interações orientadas por eventos**: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n- **Modelos de entrada e saída orientados por eventos**: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n- **Processamento e validação orientados por eventos**: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\n### Other related resources\n- **Primeira conceção do contrato**: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.\n\n## 5. Entrega e operações\n\nConstrua, teste, disponibilize e opere a capacidade usando o estilo de disponibilização selecionado e o contrato de interface validado.\n\n### Station questions\n- Utilize boas práticas de desenvolvimento para implementar o contrato de interface validado com frameworks, bibliotecas e normas da equipa estabelecidos.\n- Construa a implementação a partir do contrato de interface validado, usando frameworks, bibliotecas e normas da equipa estabelecidos.\n- Utilize orientação de testes para verificar funcionalidade, qualidade dos dados, compatibilidade, segurança, desempenho, resiliência e expectativas de recuperação.\n- Utilize orientação de CI/CD para automatizar construção, testes, disponibilização, configuração e rastreabilidade.\n- Utilize orientação de segurança para proteger dados, acesso, credenciais e fronteiras da plataforma.\n- Utilize a lista de verificação de auditoria para garantir que a solução cumpre requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n- Aplique orientação de entrega, testes, CI/CD, operações e segurança ao estilo de disponibilização escolhido.\n- Uma capacidade reutilizável precisa de entrega e operações fiáveis, quer se torne uma API, stream de eventos, troca de ficheiros, produto de dados ou integração direta.\n\n### Other related resources\n- **Boas práticas de desenvolvimento de API**: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.\n- **Boas práticas de teste de API**: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.\n- **APIOps CI/CD para APIs**: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n\n## 6. Garantia de qualidade e prontidão\n\nAudite o contrato de interface, os controlos, o modelo de suporte, a observabilidade, a documentação e a prontidão de ciclo de vida da capacidade antes da disponibilização.\n\n### Station questions\n- Utilize a lista de verificação de auditoria como checklist de qualidade reutilizável para contrato de interface, documentação, segurança, desempenho e prontidão de conformidade.\n- Utilize checklists, linters e ferramentas de teste para verificar consistência e conformidade com normas.\n- Colabore com equipas de governação e especialistas de domínio para garantir que a capacidade está pronta para produção.\n- Utilize recursos de auditoria e conformidade para verificar que a capacidade está pronta para disponibilização controlada e reutilização.\n- As capacidades reutilizáveis criam riscos operacionais, de dados, segurança, privacidade, conformidade e impacto nos consumidores. As verificações de prontidão reduzem surpresas antes da publicação ou utilização em produção.\n\n### Other related resources\n- **Lista de verificação de auditoria da API**: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n- **Boas práticas de conformidade da API**: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\n## 7. Publicacao e enablement\n\nPublique informação sobre a capacidade reutilizável para que os consumidores a possam descobrir, solicitar, integrar, utilizar e obter suporte.\n\n### Station questions\n- Publique informação sobre a capacidade nos catálogos, portais, gateways ou ambientes adequados para apoiar a reutilização por vários consumidores.\n- Documente como os consumidores encontram e utilizam a capacidade, incluindo processos de integração e registo.\n- Garanta que os modelos de segurança, a configuração de acesso e os termos legais são claros e acessíveis aos consumidores.\n- Publique propriedade, documentação, integração, contactos de suporte, expectativas de serviço, estado de ciclo de vida e caminhos para pedidos de acesso.\n- As capacidades reutilizáveis só criam valor quando os consumidores as conseguem encontrar, compreender o respetivo contrato de interface e expectativas de serviço, solicitar acesso e saber quem é responsável pelo suporte e pelas decisões de ciclo de vida.\n\n### Other related resources\n- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n- **Modelo de contrato de serviço**: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.\n\n## 8. Monitorização e melhoria\n\nMonitorize a utilização, fiabilidade, qualidade dos dados, resultados dos consumidores, custo operacional e oportunidades de reutilização após a disponibilização.\n\n### Station questions\n- Utilize orientação de métricas e análise para definir medidas de utilização da capacidade, fiabilidade, qualidade dos dados, custo, adoção e valor para os consumidores.\n- Analise métricas de utilização e incorpore feedback dos consumidores nas iterações da capacidade.\n- Estabeleça o hábito de rever métricas e planear atividades de melhoria contínua.\n- Utilize práticas de métricas, análise e envolvimento para melhorar a capacidade ao longo do tempo.\n- As capacidades precisam de feedback contínuo para permanecerem fiáveis, valiosas, rentáveis e reutilizáveis à medida que consumidores, sistemas, dados e plataformas mudam.\n\n### Other related resources\n- **Métricas e análise de API**: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n- **Estratégias de envolvimento da comunidade API**: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social."
      },
      {
        "id": "capability-productization-cycle:question-template-confluence-wiki",
        "cycleId": "capability-productization-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Ciclo de Produto de Capacidades question template Confluence wiki",
        "body": "h1. Ciclo de Produto de Capacidades question template\n\nUm ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.\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. Estrategia da capacidade\n\nAntes de construir qualquer coisa, defina o valor, os consumidores, a propriedade e os objetivos de negócio da capacidade.\n\nh3. Canvas questions\nh4. Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n* *Persona*: Quem é o cliente típico que passa por esta percurso?\n* *O cliente descobre a necessidade*: Como o cliente reconhece sua necessidade ou problema?\n* *Necessidade do cliente resolvida*: Como a necessidade do cliente é resolvida no final?\n* *Etapas da percurso*: Quais são as etapas que o cliente percorre em sua percurso?\n* *Dores*: Quais são os pontos fracos ou desafios do cliente?\n* *Ganhos*: Quais são os ganhos ou benefícios do cliente?\n* *Entradas e saídas*: Quais são as entradas e saídas em cada etapa?\n* *Regras de interação e processamento*: Quais são as regras de interação e processamento em cada etapa?\n\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas da Proposta de Valor da Capacidade\nQue capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?\n* *Tarefas e resultados dos utilizadores*: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?\n* *Funcionalidades da capacidade que permitem ganhos*: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?\n* *Funcionalidades da capacidade que aliviam dores*: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?\n* *Capacidades reutilizáveis*: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?\n\nh4. Canvas do Modelo de Negócio da Capacidade\nQuão viável, reutilizável, financiada, atribuída, apoiada e detetável deve ser esta capacidade de integração?\n* *Proposta de valor da capacidade*: Que valor esta capacidade reutilizável oferece aos utilizadores e à organização ou ecossistema?\n* *Segmentos de utilizadores da capacidade*: Quem são os utilizadores atuais e potenciais da capacidade, incluindo equipas, parceiros, sistemas, produtos ou utilizadores de dados?\n* *Envolvimento dos utilizadores*: Como irão os utilizadores descobrir, avaliar, solicitar, integrar-se, obter apoio e dar feedback sobre a capacidade?\n* *Canais*: Através de que catálogos, portais, marketplaces, sites de documentação, caminhos de apoio ou processos de governação os utilizadores irão interagir com a capacidade?\n* *Recursos-chave*: Que sistemas, ativos de dados, plataformas, pessoas, normas, financiamento e capacidades operacionais são necessários?\n* *Atividades-chave*: O que o responsável pela capacidade e os produtores devem fazer para conceber, entregar, governar, apoiar e melhorar a capacidade?\n* *Parceiros-chave*: Que parceiros de negócio, tecnologia, dados, segurança, jurídico, plataforma ou externos são necessários para que a capacidade funcione?\n* *Benefícios*: Que benefícios de negócio, operacionais, de ecossistema, reutilização, conformidade ou custo justificam a capacidade?\n* *Custos*: Quais são os custos significativos de construir, operar, governar, apoiar e evoluir a capacidade?\n\nh2. 2. Requisitos e onboarding de utilizadores\n\nRecolha requisitos de integração dos consumidores, normas, requisitos não funcionais, expectativas de serviço, restrições, necessidades de segurança, protocolos permitidos, atualidade dos dados, SLAs, observabilidade, recuperação, requisitos de adoção e responsabilidades dos produtores.\n\nh3. Canvas questions\nh4. Canvas de Requisitos da Experiência do Utilizador\nQue requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?\n* *Objetivos dos utilizadores*: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?\n* *Disponibilidade e atualidade*: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?\n* *Volume e desempenho*: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?\n* *Qualidade e consistência dos dados*: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?\n* *Segurança, privacidade e conformidade*: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?\n* *Integração e acesso*: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?\n* *Mudança e controlo de versões*: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?\n* *Observabilidade e apoio*: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?\n* *Recuperação e continuidade*: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?\n* *Implicações de arquitetura*: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?\n\nh3. Other related resources\n* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n\nh2. 3. Decisões de arquitetura e plataforma\n\nUtilize requisitos e restrições para decidir o padrão de arquitetura certo e as capacidades de plataforma de suporte.\n\nh3. Canvas questions\nh4. Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n* *Riscos de disponibilidade*: Quais são os riscos potenciais para a disponibilidade da API?\n* *Mitigar riscos de disponibilidade*: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n* *Riscos de segurança*: Quais são os riscos potenciais de segurança associados à API?\n* *Mitigar riscos de segurança*: Como o fornecedor da API pode mitigar os riscos de segurança?\n* *Riscos de dados*: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n* *Mitigar riscos de dados*: Como o fornecedor da API pode mitigar os riscos de dados?\n\nh4. Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n* *Grupos de Localização / Confiança*: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n* *Características do grupo*: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n* *Locais / Zonas Relevantes*: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n* *Características de localização / zona*: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n* *Distâncias de Rede / Regulatórias*: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n* *Características da Distância*: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n* *Pontos de extremidade de conectividade*: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n* *Características de acesso aos pontos de extremidade*: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\nh4. Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n* *Volumes de negócio atuais*: Quais são os volumes de negócio e as taxas de transação atuais?\n* *Tendências de consumo futuro*: Quais são as tendências de consumo futuro previstas?\n* *Requisitos de pico de carga e disponibilidade*: Quais são os requisitos de pico de carga e disponibilidade?\n* *Estratégias de cache*: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n* *Estratégias de limitação de pedidos*: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n* *Estratégias de dimensionamento*: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\nh2. 4. Conceção da solução e da interface\n\nConceba o contrato de interface e o modelo de interação para o estilo de disponibilização selecionado.\n\nh3. Canvas questions\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n* *Interações CRUD*: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n* *Modelos de entrada e saída CRUD*: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n* *Processamento e validação CRUD*: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n* *Interações orientadas por consulta*: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n* *Modelos de entrada e saída orientados por consulta*: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n* *Processamento e validação orientados por consulta*: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n* *Interações orientadas por comando*: Quais comandos de alteração de estado são necessários, se houver?\n* *Modelos de entrada e saída orientados por comando*: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Processamento e validação orientados por comando*: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Interações orientadas por eventos*: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n* *Modelos de entrada e saída orientados por eventos*: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n* *Processamento e validação orientados por eventos*: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\nh3. Other related resources\n* *Primeira conceção do contrato*: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.\n\nh2. 5. Entrega e operações\n\nConstrua, teste, disponibilize e opere a capacidade usando o estilo de disponibilização selecionado e o contrato de interface validado.\n\nh3. Station questions\n* Utilize boas práticas de desenvolvimento para implementar o contrato de interface validado com frameworks, bibliotecas e normas da equipa estabelecidos.\n* Construa a implementação a partir do contrato de interface validado, usando frameworks, bibliotecas e normas da equipa estabelecidos.\n* Utilize orientação de testes para verificar funcionalidade, qualidade dos dados, compatibilidade, segurança, desempenho, resiliência e expectativas de recuperação.\n* Utilize orientação de CI/CD para automatizar construção, testes, disponibilização, configuração e rastreabilidade.\n* Utilize orientação de segurança para proteger dados, acesso, credenciais e fronteiras da plataforma.\n* Utilize a lista de verificação de auditoria para garantir que a solução cumpre requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n* Aplique orientação de entrega, testes, CI/CD, operações e segurança ao estilo de disponibilização escolhido.\n* Uma capacidade reutilizável precisa de entrega e operações fiáveis, quer se torne uma API, stream de eventos, troca de ficheiros, produto de dados ou integração direta.\n\nh3. Other related resources\n* *Boas práticas de desenvolvimento de API*: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.\n* *Boas práticas de teste de API*: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.\n* *APIOps CI/CD para APIs*: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n\nh2. 6. Garantia de qualidade e prontidão\n\nAudite o contrato de interface, os controlos, o modelo de suporte, a observabilidade, a documentação e a prontidão de ciclo de vida da capacidade antes da disponibilização.\n\nh3. Station questions\n* Utilize a lista de verificação de auditoria como checklist de qualidade reutilizável para contrato de interface, documentação, segurança, desempenho e prontidão de conformidade.\n* Utilize checklists, linters e ferramentas de teste para verificar consistência e conformidade com normas.\n* Colabore com equipas de governação e especialistas de domínio para garantir que a capacidade está pronta para produção.\n* Utilize recursos de auditoria e conformidade para verificar que a capacidade está pronta para disponibilização controlada e reutilização.\n* As capacidades reutilizáveis criam riscos operacionais, de dados, segurança, privacidade, conformidade e impacto nos consumidores. As verificações de prontidão reduzem surpresas antes da publicação ou utilização em produção.\n\nh3. Other related resources\n* *Lista de verificação de auditoria da API*: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n* *Boas práticas de conformidade da API*: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\nh2. 7. Publicacao e enablement\n\nPublique informação sobre a capacidade reutilizável para que os consumidores a possam descobrir, solicitar, integrar, utilizar e obter suporte.\n\nh3. Station questions\n* Publique informação sobre a capacidade nos catálogos, portais, gateways ou ambientes adequados para apoiar a reutilização por vários consumidores.\n* Documente como os consumidores encontram e utilizam a capacidade, incluindo processos de integração e registo.\n* Garanta que os modelos de segurança, a configuração de acesso e os termos legais são claros e acessíveis aos consumidores.\n* Publique propriedade, documentação, integração, contactos de suporte, expectativas de serviço, estado de ciclo de vida e caminhos para pedidos de acesso.\n* As capacidades reutilizáveis só criam valor quando os consumidores as conseguem encontrar, compreender o respetivo contrato de interface e expectativas de serviço, solicitar acesso e saber quem é responsável pelo suporte e pelas decisões de ciclo de vida.\n\nh3. Other related resources\n* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n* *Modelo de contrato de serviço*: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.\n\nh2. 8. Monitorização e melhoria\n\nMonitorize a utilização, fiabilidade, qualidade dos dados, resultados dos consumidores, custo operacional e oportunidades de reutilização após a disponibilização.\n\nh3. Station questions\n* Utilize orientação de métricas e análise para definir medidas de utilização da capacidade, fiabilidade, qualidade dos dados, custo, adoção e valor para os consumidores.\n* Analise métricas de utilização e incorpore feedback dos consumidores nas iterações da capacidade.\n* Estabeleça o hábito de rever métricas e planear atividades de melhoria contínua.\n* Utilize práticas de métricas, análise e envolvimento para melhorar a capacidade ao longo do tempo.\n* As capacidades precisam de feedback contínuo para permanecerem fiáveis, valiosas, rentáveis e reutilizáveis à medida que consumidores, sistemas, dados e plataformas mudam.\n\nh3. Other related resources\n* *Métricas e análise de API*: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n* *Estratégias de envolvimento da comunidade API*: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social."
      },
      {
        "id": "api-productization-cycle:question-template-markdown",
        "cycleId": "api-productization-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Ciclo de Produto de API question template Markdown",
        "body": "# Ciclo de Produto de API question template\n\nA jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.\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. Estratégia de produto API\n\nAntes de construir qualquer coisa, defina o valor da sua API, os utilizadores e os objetivos de negócio desde o primeiro dia.\n\n### Canvas questions\n#### Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n- **Persona**: Quem é o cliente típico que passa por esta percurso?\n- **O cliente descobre a necessidade**: Como o cliente reconhece sua necessidade ou problema?\n- **Necessidade do cliente resolvida**: Como a necessidade do cliente é resolvida no final?\n- **Etapas da percurso**: Quais são as etapas que o cliente percorre em sua percurso?\n- **Dores**: Quais são os pontos fracos ou desafios do cliente?\n- **Ganhos**: Quais são os ganhos ou benefícios do cliente?\n- **Entradas e saídas**: Quais são as entradas e saídas em cada etapa?\n- **Regras de interação e processamento**: Quais são as regras de interação e processamento em cada etapa?\n\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas da Proposta de Valor da API\nComo a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?\n- **Tarefas**: O que os clientes (utilizadores finais) estão a tentar alcançar?\n- **Recursos que possibilitam ganhos**: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?\n- **Recursos que aliviam dificuldades**: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?\n- **Produtos API**: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?\n\n#### Canvas do Modelo de Negócio da API\nQual será a viabilidade e a reutilização desta API? Temos um caso de negócio do ponto de vista de custo-benefício?\n- **Proposta de valor da API**: Comece com uma nota adesiva que nomeie a API ou a família de APIs e, em seguida, anote o valor que a API oferece aos seus utilizadores.\n- **Segmentos de utilizadores da API**: Quem é o público-alvo da API?\n- **Relações com programadores**: Como o fornecedor da API alcança e oferece apoio aos utilizadores da API?\n- **Canais**: Através de quais mecanismos os utilizadores da API interagem com a API?\n- **Recursos-chave**: Que ativos estratégicos exclusivos deve o fornecedor da API adquirir ou construir?\n- **Atividades-chave**: Quais são as ações mais importantes que o fornecedor da API deve realizar para operar com sucesso?\n- **Parceiros-chave**: Quem são as principais partes interessadas envolvidas?\n- **Benefícios**: Quais são os benefícios significativos ou fluxos de receita gerados pela API?\n- **Custos**: Quais são os custos significativos envolvidos na construção, disponibilização e operação da API?\n\n## 2. Experiência do consumidor da API\n\nCertifique-se de que a sua API é detetável, compreensível e utilizável - antes e depois do lançamento.\n\n### Canvas questions\n#### Canvas da Proposta de Valor da API\nComo a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?\n- **Tarefas**: O que os clientes (utilizadores finais) estão a tentar alcançar?\n- **Recursos que possibilitam ganhos**: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?\n- **Recursos que aliviam dificuldades**: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?\n- **Produtos API**: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?\n\n#### Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n- **Persona**: Quem é o cliente típico que passa por esta percurso?\n- **O cliente descobre a necessidade**: Como o cliente reconhece sua necessidade ou problema?\n- **Necessidade do cliente resolvida**: Como a necessidade do cliente é resolvida no final?\n- **Etapas da percurso**: Quais são as etapas que o cliente percorre em sua percurso?\n- **Dores**: Quais são os pontos fracos ou desafios do cliente?\n- **Ganhos**: Quais são os ganhos ou benefícios do cliente?\n- **Entradas e saídas**: Quais são as entradas e saídas em cada etapa?\n- **Regras de interação e processamento**: Quais são as regras de interação e processamento em cada etapa?\n\n### Other related resources\n- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n\n## 3. Arquitetura da plataforma API\n\nGaranta a escalabilidade, a reutilização e a governação da sua API e dos componentes da plataforma.\n\n### Canvas questions\n#### Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n- **Riscos de disponibilidade**: Quais são os riscos potenciais para a disponibilidade da API?\n- **Mitigar riscos de disponibilidade**: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n- **Riscos de segurança**: Quais são os riscos potenciais de segurança associados à API?\n- **Mitigar riscos de segurança**: Como o fornecedor da API pode mitigar os riscos de segurança?\n- **Riscos de dados**: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n- **Mitigar riscos de dados**: Como o fornecedor da API pode mitigar os riscos de dados?\n\n#### Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n- **Grupos de Localização / Confiança**: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n- **Características do grupo**: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n- **Locais / Zonas Relevantes**: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n- **Características de localização / zona**: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n- **Distâncias de Rede / Regulatórias**: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n- **Características da Distância**: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n- **Pontos de extremidade de conectividade**: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n- **Características de acesso aos pontos de extremidade**: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\n#### Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n- **Volumes de negócio atuais**: Quais são os volumes de negócio e as taxas de transação atuais?\n- **Tendências de consumo futuro**: Quais são as tendências de consumo futuro previstas?\n- **Requisitos de pico de carga e disponibilidade**: Quais são os requisitos de pico de carga e disponibilidade?\n- **Estratégias de cache**: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n- **Estratégias de limitação de pedidos**: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n- **Estratégias de dimensionamento**: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\n### Other related resources\n- **Métricas e análise de API**: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n\n## 4. Conceção da API\n\nCriar conceções de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.\n\n### Canvas questions\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n- **Interações CRUD**: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n- **Modelos de entrada e saída CRUD**: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n- **Processamento e validação CRUD**: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n- **Interações orientadas por consulta**: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n- **Modelos de entrada e saída orientados por consulta**: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n- **Processamento e validação orientados por consulta**: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n- **Interações orientadas por comando**: Quais comandos de alteração de estado são necessários, se houver?\n- **Modelos de entrada e saída orientados por comando**: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Processamento e validação orientados por comando**: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Interações orientadas por eventos**: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n- **Modelos de entrada e saída orientados por eventos**: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n- **Processamento e validação orientados por eventos**: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\n#### Canvas REST\nComo a API pode ser concebida utilizando os princípios RESTful?\n- **Recursos da API**: Quais são os principais recursos expostos pela API?\n- **Modelo de recurso da API**: Qual é a estrutura do modelo de recurso da API?\n- **Verbos da API**: Quais verbos HTTP são usados para interagir com os recursos da API?\n- **Exemplo de verbo da API**: Forneça um exemplo de pedido e resposta da API para cada verbo.\n\n#### Canvas de Eventos\nQuais eventos são relevantes para a API e como são processados?\n- **Tarefa do utilizador/gatilho**: Que ação do utilizador ou evento do sistema aciona esta operação de evento?\n- **Entrada / Carga útil do evento**: Que dados estão incluídos na carga útil do evento recebido? Especifique os atributos principais.\n- **Processamento/Lógica**: Descreva a lógica de processamento de back-end, incluindo validações, transformações ou decisões de encaminhamento.\n- **Saída/Resultado do evento**: Que evento ou confirmação resultante é produzido? Inclua atributos da carga útil de saída.\n\n#### Canvas GraphQL\nComo a API pode ser concebida utilizando os princípios do GraphQL?\n- **Nome da API**: Qual é o nome da API GraphQL ou do endpoint?\n- **Objetivos do utilizador**: Que problemas os utilizadores da API estão a tentar resolver? De que dados precisam?\n- **Tipos de chave**: Quais são os tipos principais expostos (por exemplo, Utilizador, Pedido, Produto)?\n- **Relações**: Como os tipos se relacionam entre si em consultas aninhadas?\n- **Consultas**: Quais consultas comuns devem ser suportadas?\n- **Mutações**: Quais operações modificarão os dados (por exemplo, criar, atualizar, eliminar)?\n- **Assinaturas**: Existem atualizações em tempo real ou eventos que os utilizadores podem assinar?\n- **Regras de autorização**: Quem pode aceder quais campos ou tipos?\n- **Restrições do utilizador**: Existem restrições de paginação, filtragem ou limitação de pedidos?\n- **Notas/Questões em aberto**: Alguma decisão pendente ou considerações sobre integração?\n\n### Other related resources\n- **Princípios de conceção da API**: Um guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design partilhadas e nas necessidades reais dos utilizadores.\n- **Primeira conceção do contrato**: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.\n\n## 5. Entrega da API\n\nCriar, testar e lançar APIs usando pipelines de entrega modernos e boas práticas de engenharia.\n\n### Station questions\n- Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.\n- Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.\n- Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.\n- Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.\n- Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.\n- Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n- Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.\n- Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.\n\n### Other related resources\n- **Boas práticas de desenvolvimento de API**: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.\n- **Boas práticas de teste de API**: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.\n- **APIOps CI/CD para APIs**: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n- **Boas práticas de segurança da API**: Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.\n\n## 6. Auditoria da API\n\nValide se as APIs satisfazemos padrões de negócio, conceção e operacionais antes da publicação e exposição.\n\n### Station questions\n- Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.\n- Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.\n- Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.\n- Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.\n- As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.\n\n### Other related resources\n- **Lista de verificação de auditoria da API**: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n- **Boas práticas de conformidade da API**: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\n## 7. Publicação da API\n\nExponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.\n\n### Station questions\n- Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.\n- Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.\n- Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.\n- Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.\n- A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.\n\n### Other related resources\n- **APIOps CI/CD para APIs**: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n- **Lista de verificação de auditoria da API**: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n\n## 8. Monitorizacao e melhoria da API\n\nUtilizar métricas e feedback para acompanhar o desempenho da API e promover a melhoria contínua.\n\n### Station questions\n- Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).\n- Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.\n- Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.\n- Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.\n- A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.\n\n### Other related resources\n- **Métricas e análise de API**: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n- **Estratégias de envolvimento da comunidade API**: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social."
      },
      {
        "id": "api-productization-cycle:question-template-confluence-wiki",
        "cycleId": "api-productization-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Ciclo de Produto de API question template Confluence wiki",
        "body": "h1. Ciclo de Produto de API question template\n\nA jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.\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. Estratégia de produto API\n\nAntes de construir qualquer coisa, defina o valor da sua API, os utilizadores e os objetivos de negócio desde o primeiro dia.\n\nh3. Canvas questions\nh4. Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n* *Persona*: Quem é o cliente típico que passa por esta percurso?\n* *O cliente descobre a necessidade*: Como o cliente reconhece sua necessidade ou problema?\n* *Necessidade do cliente resolvida*: Como a necessidade do cliente é resolvida no final?\n* *Etapas da percurso*: Quais são as etapas que o cliente percorre em sua percurso?\n* *Dores*: Quais são os pontos fracos ou desafios do cliente?\n* *Ganhos*: Quais são os ganhos ou benefícios do cliente?\n* *Entradas e saídas*: Quais são as entradas e saídas em cada etapa?\n* *Regras de interação e processamento*: Quais são as regras de interação e processamento em cada etapa?\n\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas da Proposta de Valor da API\nComo a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?\n* *Tarefas*: O que os clientes (utilizadores finais) estão a tentar alcançar?\n* *Recursos que possibilitam ganhos*: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?\n* *Recursos que aliviam dificuldades*: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?\n* *Produtos API*: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?\n\nh4. Canvas do Modelo de Negócio da API\nQual será a viabilidade e a reutilização desta API? Temos um caso de negócio do ponto de vista de custo-benefício?\n* *Proposta de valor da API*: Comece com uma nota adesiva que nomeie a API ou a família de APIs e, em seguida, anote o valor que a API oferece aos seus utilizadores.\n* *Segmentos de utilizadores da API*: Quem é o público-alvo da API?\n* *Relações com programadores*: Como o fornecedor da API alcança e oferece apoio aos utilizadores da API?\n* *Canais*: Através de quais mecanismos os utilizadores da API interagem com a API?\n* *Recursos-chave*: Que ativos estratégicos exclusivos deve o fornecedor da API adquirir ou construir?\n* *Atividades-chave*: Quais são as ações mais importantes que o fornecedor da API deve realizar para operar com sucesso?\n* *Parceiros-chave*: Quem são as principais partes interessadas envolvidas?\n* *Benefícios*: Quais são os benefícios significativos ou fluxos de receita gerados pela API?\n* *Custos*: Quais são os custos significativos envolvidos na construção, disponibilização e operação da API?\n\nh2. 2. Experiência do consumidor da API\n\nCertifique-se de que a sua API é detetável, compreensível e utilizável - antes e depois do lançamento.\n\nh3. Canvas questions\nh4. Canvas da Proposta de Valor da API\nComo a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?\n* *Tarefas*: O que os clientes (utilizadores finais) estão a tentar alcançar?\n* *Recursos que possibilitam ganhos*: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?\n* *Recursos que aliviam dificuldades*: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?\n* *Produtos API*: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?\n\nh4. Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n* *Persona*: Quem é o cliente típico que passa por esta percurso?\n* *O cliente descobre a necessidade*: Como o cliente reconhece sua necessidade ou problema?\n* *Necessidade do cliente resolvida*: Como a necessidade do cliente é resolvida no final?\n* *Etapas da percurso*: Quais são as etapas que o cliente percorre em sua percurso?\n* *Dores*: Quais são os pontos fracos ou desafios do cliente?\n* *Ganhos*: Quais são os ganhos ou benefícios do cliente?\n* *Entradas e saídas*: Quais são as entradas e saídas em cada etapa?\n* *Regras de interação e processamento*: Quais são as regras de interação e processamento em cada etapa?\n\nh3. Other related resources\n* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n\nh2. 3. Arquitetura da plataforma API\n\nGaranta a escalabilidade, a reutilização e a governação da sua API e dos componentes da plataforma.\n\nh3. Canvas questions\nh4. Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n* *Riscos de disponibilidade*: Quais são os riscos potenciais para a disponibilidade da API?\n* *Mitigar riscos de disponibilidade*: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n* *Riscos de segurança*: Quais são os riscos potenciais de segurança associados à API?\n* *Mitigar riscos de segurança*: Como o fornecedor da API pode mitigar os riscos de segurança?\n* *Riscos de dados*: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n* *Mitigar riscos de dados*: Como o fornecedor da API pode mitigar os riscos de dados?\n\nh4. Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n* *Grupos de Localização / Confiança*: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n* *Características do grupo*: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n* *Locais / Zonas Relevantes*: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n* *Características de localização / zona*: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n* *Distâncias de Rede / Regulatórias*: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n* *Características da Distância*: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n* *Pontos de extremidade de conectividade*: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n* *Características de acesso aos pontos de extremidade*: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\nh4. Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n* *Volumes de negócio atuais*: Quais são os volumes de negócio e as taxas de transação atuais?\n* *Tendências de consumo futuro*: Quais são as tendências de consumo futuro previstas?\n* *Requisitos de pico de carga e disponibilidade*: Quais são os requisitos de pico de carga e disponibilidade?\n* *Estratégias de cache*: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n* *Estratégias de limitação de pedidos*: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n* *Estratégias de dimensionamento*: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\nh3. Other related resources\n* *Métricas e análise de API*: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n\nh2. 4. Conceção da API\n\nCriar conceções de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.\n\nh3. Canvas questions\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n* *Interações CRUD*: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n* *Modelos de entrada e saída CRUD*: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n* *Processamento e validação CRUD*: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n* *Interações orientadas por consulta*: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n* *Modelos de entrada e saída orientados por consulta*: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n* *Processamento e validação orientados por consulta*: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n* *Interações orientadas por comando*: Quais comandos de alteração de estado são necessários, se houver?\n* *Modelos de entrada e saída orientados por comando*: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Processamento e validação orientados por comando*: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Interações orientadas por eventos*: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n* *Modelos de entrada e saída orientados por eventos*: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n* *Processamento e validação orientados por eventos*: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\nh4. Canvas REST\nComo a API pode ser concebida utilizando os princípios RESTful?\n* *Recursos da API*: Quais são os principais recursos expostos pela API?\n* *Modelo de recurso da API*: Qual é a estrutura do modelo de recurso da API?\n* *Verbos da API*: Quais verbos HTTP são usados para interagir com os recursos da API?\n* *Exemplo de verbo da API*: Forneça um exemplo de pedido e resposta da API para cada verbo.\n\nh4. Canvas de Eventos\nQuais eventos são relevantes para a API e como são processados?\n* *Tarefa do utilizador/gatilho*: Que ação do utilizador ou evento do sistema aciona esta operação de evento?\n* *Entrada / Carga útil do evento*: Que dados estão incluídos na carga útil do evento recebido? Especifique os atributos principais.\n* *Processamento/Lógica*: Descreva a lógica de processamento de back-end, incluindo validações, transformações ou decisões de encaminhamento.\n* *Saída/Resultado do evento*: Que evento ou confirmação resultante é produzido? Inclua atributos da carga útil de saída.\n\nh4. Canvas GraphQL\nComo a API pode ser concebida utilizando os princípios do GraphQL?\n* *Nome da API*: Qual é o nome da API GraphQL ou do endpoint?\n* *Objetivos do utilizador*: Que problemas os utilizadores da API estão a tentar resolver? De que dados precisam?\n* *Tipos de chave*: Quais são os tipos principais expostos (por exemplo, Utilizador, Pedido, Produto)?\n* *Relações*: Como os tipos se relacionam entre si em consultas aninhadas?\n* *Consultas*: Quais consultas comuns devem ser suportadas?\n* *Mutações*: Quais operações modificarão os dados (por exemplo, criar, atualizar, eliminar)?\n* *Assinaturas*: Existem atualizações em tempo real ou eventos que os utilizadores podem assinar?\n* *Regras de autorização*: Quem pode aceder quais campos ou tipos?\n* *Restrições do utilizador*: Existem restrições de paginação, filtragem ou limitação de pedidos?\n* *Notas/Questões em aberto*: Alguma decisão pendente ou considerações sobre integração?\n\nh3. Other related resources\n* *Princípios de conceção da API*: Um guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design partilhadas e nas necessidades reais dos utilizadores.\n* *Primeira conceção do contrato*: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.\n\nh2. 5. Entrega da API\n\nCriar, testar e lançar APIs usando pipelines de entrega modernos e boas práticas de engenharia.\n\nh3. Station questions\n* Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.\n* Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.\n* Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.\n* Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.\n* Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.\n* Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n* Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.\n* Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.\n\nh3. Other related resources\n* *Boas práticas de desenvolvimento de API*: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.\n* *Boas práticas de teste de API*: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.\n* *APIOps CI/CD para APIs*: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n* *Boas práticas de segurança da API*: Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.\n\nh2. 6. Auditoria da API\n\nValide se as APIs satisfazemos padrões de negócio, conceção e operacionais antes da publicação e exposição.\n\nh3. Station questions\n* Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.\n* Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.\n* Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.\n* Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.\n* As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.\n\nh3. Other related resources\n* *Lista de verificação de auditoria da API*: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n* *Boas práticas de conformidade da API*: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\nh2. 7. Publicação da API\n\nExponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.\n\nh3. Station questions\n* Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.\n* Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.\n* Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.\n* Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.\n* A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.\n\nh3. Other related resources\n* *APIOps CI/CD para APIs*: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n* *Lista de verificação de auditoria da API*: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n\nh2. 8. Monitorizacao e melhoria da API\n\nUtilizar métricas e feedback para acompanhar o desempenho da API e promover a melhoria contínua.\n\nh3. Station questions\n* Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).\n* Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.\n* Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.\n* Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.\n* A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.\n\nh3. Other related resources\n* *Métricas e análise de API*: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n* *Estratégias de envolvimento da comunidade API*: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social."
      },
      {
        "id": "integration-productization-cycle:question-template-markdown",
        "cycleId": "integration-productization-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Ciclo de Produto de Integração question template Markdown",
        "body": "# Ciclo de Produto de Integração question template\n\nUm ciclo para transformar capacidades de integracao reutilizaveis em produto antes de selecionar o estilo de implementacao.\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. Estratégia da capacidade de integração\n\nEnquadrar a capacidade de integracao reutilizavel, a necessidade de negocio, o ownership e a reutilizacao esperada antes de selecionar o estilo de implementacao.\n\n### Canvas questions\n#### Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n- **Persona**: Quem é o cliente típico que passa por esta percurso?\n- **O cliente descobre a necessidade**: Como o cliente reconhece sua necessidade ou problema?\n- **Necessidade do cliente resolvida**: Como a necessidade do cliente é resolvida no final?\n- **Etapas da percurso**: Quais são as etapas que o cliente percorre em sua percurso?\n- **Dores**: Quais são os pontos fracos ou desafios do cliente?\n- **Ganhos**: Quais são os ganhos ou benefícios do cliente?\n- **Entradas e saídas**: Quais são as entradas e saídas em cada etapa?\n- **Regras de interação e processamento**: Quais são as regras de interação e processamento em cada etapa?\n\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas da Proposta de Valor da Capacidade\nQue capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?\n- **Tarefas e resultados dos utilizadores**: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?\n- **Funcionalidades da capacidade que permitem ganhos**: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?\n- **Funcionalidades da capacidade que aliviam dores**: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?\n- **Capacidades reutilizáveis**: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?\n\n#### Canvas do Modelo de Negócio da Capacidade\nQuão viável, reutilizável, financiada, atribuída, apoiada e detetável deve ser esta capacidade de integração?\n- **Proposta de valor da capacidade**: Que valor esta capacidade reutilizável oferece aos utilizadores e à organização ou ecossistema?\n- **Segmentos de utilizadores da capacidade**: Quem são os utilizadores atuais e potenciais da capacidade, incluindo equipas, parceiros, sistemas, produtos ou utilizadores de dados?\n- **Envolvimento dos utilizadores**: Como irão os utilizadores descobrir, avaliar, solicitar, integrar-se, obter apoio e dar feedback sobre a capacidade?\n- **Canais**: Através de que catálogos, portais, marketplaces, sites de documentação, caminhos de apoio ou processos de governação os utilizadores irão interagir com a capacidade?\n- **Recursos-chave**: Que sistemas, ativos de dados, plataformas, pessoas, normas, financiamento e capacidades operacionais são necessários?\n- **Atividades-chave**: O que o responsável pela capacidade e os produtores devem fazer para conceber, entregar, governar, apoiar e melhorar a capacidade?\n- **Parceiros-chave**: Que parceiros de negócio, tecnologia, dados, segurança, jurídico, plataforma ou externos são necessários para que a capacidade funcione?\n- **Benefícios**: Que benefícios de negócio, operacionais, de ecossistema, reutilização, conformidade ou custo justificam a capacidade?\n- **Custos**: Quais são os custos significativos de construir, operar, governar, apoiar e evoluir a capacidade?\n\n## 2. Requisitos e integração de consumidores da integração\n\nRecolha consumidores da integração, responsabilidades dos fornecedores, necessidades de integração, expectativas de serviço e restrições operacionais.\n\n### Canvas questions\n#### Canvas de Requisitos da Experiência do Utilizador\nQue requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?\n- **Objetivos dos utilizadores**: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?\n- **Disponibilidade e atualidade**: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?\n- **Volume e desempenho**: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?\n- **Qualidade e consistência dos dados**: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?\n- **Segurança, privacidade e conformidade**: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?\n- **Integração e acesso**: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?\n- **Mudança e controlo de versões**: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?\n- **Observabilidade e apoio**: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?\n- **Recuperação e continuidade**: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?\n- **Implicações de arquitetura**: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?\n\n### Other related resources\n- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n\n## 3. Arquitetura de integracao e decisoes de plataforma\n\nSelecionar a arquitetura de integracao, o estilo de implementacao e as capacidades de plataforma, tendo em conta as restricoes e o modelo de governacao.\n\n### Canvas questions\n#### Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n- **Riscos de disponibilidade**: Quais são os riscos potenciais para a disponibilidade da API?\n- **Mitigar riscos de disponibilidade**: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n- **Riscos de segurança**: Quais são os riscos potenciais de segurança associados à API?\n- **Mitigar riscos de segurança**: Como o fornecedor da API pode mitigar os riscos de segurança?\n- **Riscos de dados**: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n- **Mitigar riscos de dados**: Como o fornecedor da API pode mitigar os riscos de dados?\n\n#### Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n- **Grupos de Localização / Confiança**: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n- **Características do grupo**: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n- **Locais / Zonas Relevantes**: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n- **Características de localização / zona**: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n- **Distâncias de Rede / Regulatórias**: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n- **Características da Distância**: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n- **Pontos de extremidade de conectividade**: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n- **Características de acesso aos pontos de extremidade**: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\n#### Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n- **Volumes de negócio atuais**: Quais são os volumes de negócio e as taxas de transação atuais?\n- **Tendências de consumo futuro**: Quais são as tendências de consumo futuro previstas?\n- **Requisitos de pico de carga e disponibilidade**: Quais são os requisitos de pico de carga e disponibilidade?\n- **Estratégias de cache**: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n- **Estratégias de limitação de pedidos**: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n- **Estratégias de dimensionamento**: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\n### Other related resources\n- **Diretrizes de integração de parceiros**: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.\n\n## 4. Conceção da solução de integração\n\nConceber o contrato de interface, os esquemas, os payloads e os padroes de interacao para o estilo de integracao selecionado.\n\n### Canvas questions\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n- **Interações CRUD**: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n- **Modelos de entrada e saída CRUD**: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n- **Processamento e validação CRUD**: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n- **Interações orientadas por consulta**: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n- **Modelos de entrada e saída orientados por consulta**: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n- **Processamento e validação orientados por consulta**: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n- **Interações orientadas por comando**: Quais comandos de alteração de estado são necessários, se houver?\n- **Modelos de entrada e saída orientados por comando**: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Processamento e validação orientados por comando**: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Interações orientadas por eventos**: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n- **Modelos de entrada e saída orientados por eventos**: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n- **Processamento e validação orientados por eventos**: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\n#### Canvas REST\nComo a API pode ser concebida utilizando os princípios RESTful?\n- **Recursos da API**: Quais são os principais recursos expostos pela API?\n- **Modelo de recurso da API**: Qual é a estrutura do modelo de recurso da API?\n- **Verbos da API**: Quais verbos HTTP são usados para interagir com os recursos da API?\n- **Exemplo de verbo da API**: Forneça um exemplo de pedido e resposta da API para cada verbo.\n\n#### Canvas de Eventos\nQuais eventos são relevantes para a API e como são processados?\n- **Tarefa do utilizador/gatilho**: Que ação do utilizador ou evento do sistema aciona esta operação de evento?\n- **Entrada / Carga útil do evento**: Que dados estão incluídos na carga útil do evento recebido? Especifique os atributos principais.\n- **Processamento/Lógica**: Descreva a lógica de processamento de back-end, incluindo validações, transformações ou decisões de encaminhamento.\n- **Saída/Resultado do evento**: Que evento ou confirmação resultante é produzido? Inclua atributos da carga útil de saída.\n\n#### Canvas GraphQL\nComo a API pode ser concebida utilizando os princípios do GraphQL?\n- **Nome da API**: Qual é o nome da API GraphQL ou do endpoint?\n- **Objetivos do utilizador**: Que problemas os utilizadores da API estão a tentar resolver? De que dados precisam?\n- **Tipos de chave**: Quais são os tipos principais expostos (por exemplo, Utilizador, Pedido, Produto)?\n- **Relações**: Como os tipos se relacionam entre si em consultas aninhadas?\n- **Consultas**: Quais consultas comuns devem ser suportadas?\n- **Mutações**: Quais operações modificarão os dados (por exemplo, criar, atualizar, eliminar)?\n- **Assinaturas**: Existem atualizações em tempo real ou eventos que os utilizadores podem assinar?\n- **Regras de autorização**: Quem pode aceder quais campos ou tipos?\n- **Restrições do utilizador**: Existem restrições de paginação, filtragem ou limitação de pedidos?\n- **Notas/Questões em aberto**: Alguma decisão pendente ou considerações sobre integração?\n\n### Other related resources\n- **Guia de seleção do estilo de implementação**: Orientação para escolher entre API, evento, ficheiro, stream, produto de dados, integração direta ou estilos de implementação híbridos com base nos requisitos e restrições.\n- **Primeira conceção do contrato**: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.\n\n## 5. Entrega e operações da integração\n\nConstruir, testar, automatizar, disponibilizar e operar a capacidade de integracao usando o estilo de implementacao selecionado e o contrato de interface validado.\n\n### Station questions\n- Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.\n- Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.\n- Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.\n- Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.\n- Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.\n- Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n- Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.\n- Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.\n\n### Other related resources\n- **Boas práticas de desenvolvimento de API**: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.\n- **Boas práticas de teste de API**: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.\n- **APIOps CI/CD para APIs**: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n- **Boas práticas de segurança da API**: Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.\n- **Diretrizes de integração de parceiros**: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.\n\n## 6. Garantia de prontidão da integração\n\nAssegure a prontidão, a governação, a qualidade, a segurança, a conformidade e as evidências operacionais da integração antes da disponibilização.\n\n### Station questions\n- Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.\n- Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.\n- Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.\n- Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.\n- As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.\n\n### Other related resources\n- **Lista de verificação de auditoria da API**: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n- **Boas práticas de conformidade da API**: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\n## 7. Publicacao e enablement da integracao\n\nPublicar a capacidade de integracao para que as equipas a possam descobrir, avaliar, solicitar acesso, concluir o onboarding, reutiliza-la e obter suporte.\n\n### Station questions\n- Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.\n- Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.\n- Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.\n- Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.\n- A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.\n\n### Other related resources\n- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n- **Modelo de contrato de serviço**: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.\n\n## 8. Monitorização e melhoria da integração\n\nMonitorize a fiabilidade da integração, a reutilização, os incidentes, o desempenho, os resultados dos consumidores e as necessidades de melhoria.\n\n### Station questions\n- Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).\n- Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.\n- Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.\n- Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.\n- A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.\n\n### Other related resources\n- **Métricas e análise de API**: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n- **Estratégias de envolvimento da comunidade API**: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social."
      },
      {
        "id": "integration-productization-cycle:question-template-confluence-wiki",
        "cycleId": "integration-productization-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Ciclo de Produto de Integração question template Confluence wiki",
        "body": "h1. Ciclo de Produto de Integração question template\n\nUm ciclo para transformar capacidades de integracao reutilizaveis em produto antes de selecionar o estilo de implementacao.\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. Estratégia da capacidade de integração\n\nEnquadrar a capacidade de integracao reutilizavel, a necessidade de negocio, o ownership e a reutilizacao esperada antes de selecionar o estilo de implementacao.\n\nh3. Canvas questions\nh4. Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n* *Persona*: Quem é o cliente típico que passa por esta percurso?\n* *O cliente descobre a necessidade*: Como o cliente reconhece sua necessidade ou problema?\n* *Necessidade do cliente resolvida*: Como a necessidade do cliente é resolvida no final?\n* *Etapas da percurso*: Quais são as etapas que o cliente percorre em sua percurso?\n* *Dores*: Quais são os pontos fracos ou desafios do cliente?\n* *Ganhos*: Quais são os ganhos ou benefícios do cliente?\n* *Entradas e saídas*: Quais são as entradas e saídas em cada etapa?\n* *Regras de interação e processamento*: Quais são as regras de interação e processamento em cada etapa?\n\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas da Proposta de Valor da Capacidade\nQue capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?\n* *Tarefas e resultados dos utilizadores*: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?\n* *Funcionalidades da capacidade que permitem ganhos*: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?\n* *Funcionalidades da capacidade que aliviam dores*: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?\n* *Capacidades reutilizáveis*: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?\n\nh4. Canvas do Modelo de Negócio da Capacidade\nQuão viável, reutilizável, financiada, atribuída, apoiada e detetável deve ser esta capacidade de integração?\n* *Proposta de valor da capacidade*: Que valor esta capacidade reutilizável oferece aos utilizadores e à organização ou ecossistema?\n* *Segmentos de utilizadores da capacidade*: Quem são os utilizadores atuais e potenciais da capacidade, incluindo equipas, parceiros, sistemas, produtos ou utilizadores de dados?\n* *Envolvimento dos utilizadores*: Como irão os utilizadores descobrir, avaliar, solicitar, integrar-se, obter apoio e dar feedback sobre a capacidade?\n* *Canais*: Através de que catálogos, portais, marketplaces, sites de documentação, caminhos de apoio ou processos de governação os utilizadores irão interagir com a capacidade?\n* *Recursos-chave*: Que sistemas, ativos de dados, plataformas, pessoas, normas, financiamento e capacidades operacionais são necessários?\n* *Atividades-chave*: O que o responsável pela capacidade e os produtores devem fazer para conceber, entregar, governar, apoiar e melhorar a capacidade?\n* *Parceiros-chave*: Que parceiros de negócio, tecnologia, dados, segurança, jurídico, plataforma ou externos são necessários para que a capacidade funcione?\n* *Benefícios*: Que benefícios de negócio, operacionais, de ecossistema, reutilização, conformidade ou custo justificam a capacidade?\n* *Custos*: Quais são os custos significativos de construir, operar, governar, apoiar e evoluir a capacidade?\n\nh2. 2. Requisitos e integração de consumidores da integração\n\nRecolha consumidores da integração, responsabilidades dos fornecedores, necessidades de integração, expectativas de serviço e restrições operacionais.\n\nh3. Canvas questions\nh4. Canvas de Requisitos da Experiência do Utilizador\nQue requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?\n* *Objetivos dos utilizadores*: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?\n* *Disponibilidade e atualidade*: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?\n* *Volume e desempenho*: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?\n* *Qualidade e consistência dos dados*: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?\n* *Segurança, privacidade e conformidade*: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?\n* *Integração e acesso*: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?\n* *Mudança e controlo de versões*: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?\n* *Observabilidade e apoio*: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?\n* *Recuperação e continuidade*: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?\n* *Implicações de arquitetura*: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?\n\nh3. Other related resources\n* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n\nh2. 3. Arquitetura de integracao e decisoes de plataforma\n\nSelecionar a arquitetura de integracao, o estilo de implementacao e as capacidades de plataforma, tendo em conta as restricoes e o modelo de governacao.\n\nh3. Canvas questions\nh4. Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n* *Riscos de disponibilidade*: Quais são os riscos potenciais para a disponibilidade da API?\n* *Mitigar riscos de disponibilidade*: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n* *Riscos de segurança*: Quais são os riscos potenciais de segurança associados à API?\n* *Mitigar riscos de segurança*: Como o fornecedor da API pode mitigar os riscos de segurança?\n* *Riscos de dados*: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n* *Mitigar riscos de dados*: Como o fornecedor da API pode mitigar os riscos de dados?\n\nh4. Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n* *Grupos de Localização / Confiança*: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n* *Características do grupo*: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n* *Locais / Zonas Relevantes*: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n* *Características de localização / zona*: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n* *Distâncias de Rede / Regulatórias*: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n* *Características da Distância*: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n* *Pontos de extremidade de conectividade*: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n* *Características de acesso aos pontos de extremidade*: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\nh4. Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n* *Volumes de negócio atuais*: Quais são os volumes de negócio e as taxas de transação atuais?\n* *Tendências de consumo futuro*: Quais são as tendências de consumo futuro previstas?\n* *Requisitos de pico de carga e disponibilidade*: Quais são os requisitos de pico de carga e disponibilidade?\n* *Estratégias de cache*: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n* *Estratégias de limitação de pedidos*: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n* *Estratégias de dimensionamento*: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\nh3. Other related resources\n* *Diretrizes de integração de parceiros*: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.\n\nh2. 4. Conceção da solução de integração\n\nConceber o contrato de interface, os esquemas, os payloads e os padroes de interacao para o estilo de integracao selecionado.\n\nh3. Canvas questions\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n* *Interações CRUD*: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n* *Modelos de entrada e saída CRUD*: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n* *Processamento e validação CRUD*: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n* *Interações orientadas por consulta*: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n* *Modelos de entrada e saída orientados por consulta*: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n* *Processamento e validação orientados por consulta*: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n* *Interações orientadas por comando*: Quais comandos de alteração de estado são necessários, se houver?\n* *Modelos de entrada e saída orientados por comando*: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Processamento e validação orientados por comando*: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Interações orientadas por eventos*: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n* *Modelos de entrada e saída orientados por eventos*: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n* *Processamento e validação orientados por eventos*: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\nh4. Canvas REST\nComo a API pode ser concebida utilizando os princípios RESTful?\n* *Recursos da API*: Quais são os principais recursos expostos pela API?\n* *Modelo de recurso da API*: Qual é a estrutura do modelo de recurso da API?\n* *Verbos da API*: Quais verbos HTTP são usados para interagir com os recursos da API?\n* *Exemplo de verbo da API*: Forneça um exemplo de pedido e resposta da API para cada verbo.\n\nh4. Canvas de Eventos\nQuais eventos são relevantes para a API e como são processados?\n* *Tarefa do utilizador/gatilho*: Que ação do utilizador ou evento do sistema aciona esta operação de evento?\n* *Entrada / Carga útil do evento*: Que dados estão incluídos na carga útil do evento recebido? Especifique os atributos principais.\n* *Processamento/Lógica*: Descreva a lógica de processamento de back-end, incluindo validações, transformações ou decisões de encaminhamento.\n* *Saída/Resultado do evento*: Que evento ou confirmação resultante é produzido? Inclua atributos da carga útil de saída.\n\nh4. Canvas GraphQL\nComo a API pode ser concebida utilizando os princípios do GraphQL?\n* *Nome da API*: Qual é o nome da API GraphQL ou do endpoint?\n* *Objetivos do utilizador*: Que problemas os utilizadores da API estão a tentar resolver? De que dados precisam?\n* *Tipos de chave*: Quais são os tipos principais expostos (por exemplo, Utilizador, Pedido, Produto)?\n* *Relações*: Como os tipos se relacionam entre si em consultas aninhadas?\n* *Consultas*: Quais consultas comuns devem ser suportadas?\n* *Mutações*: Quais operações modificarão os dados (por exemplo, criar, atualizar, eliminar)?\n* *Assinaturas*: Existem atualizações em tempo real ou eventos que os utilizadores podem assinar?\n* *Regras de autorização*: Quem pode aceder quais campos ou tipos?\n* *Restrições do utilizador*: Existem restrições de paginação, filtragem ou limitação de pedidos?\n* *Notas/Questões em aberto*: Alguma decisão pendente ou considerações sobre integração?\n\nh3. Other related resources\n* *Guia de seleção do estilo de implementação*: Orientação para escolher entre API, evento, ficheiro, stream, produto de dados, integração direta ou estilos de implementação híbridos com base nos requisitos e restrições.\n* *Primeira conceção do contrato*: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.\n\nh2. 5. Entrega e operações da integração\n\nConstruir, testar, automatizar, disponibilizar e operar a capacidade de integracao usando o estilo de implementacao selecionado e o contrato de interface validado.\n\nh3. Station questions\n* Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.\n* Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.\n* Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.\n* Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.\n* Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.\n* Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n* Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.\n* Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.\n\nh3. Other related resources\n* *Boas práticas de desenvolvimento de API*: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.\n* *Boas práticas de teste de API*: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.\n* *APIOps CI/CD para APIs*: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.\n* *Boas práticas de segurança da API*: Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.\n* *Diretrizes de integração de parceiros*: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.\n\nh2. 6. Garantia de prontidão da integração\n\nAssegure a prontidão, a governação, a qualidade, a segurança, a conformidade e as evidências operacionais da integração antes da disponibilização.\n\nh3. Station questions\n* Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.\n* Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.\n* Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.\n* Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.\n* As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.\n\nh3. Other related resources\n* *Lista de verificação de auditoria da API*: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.\n* *Boas práticas de conformidade da API*: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\nh2. 7. Publicacao e enablement da integracao\n\nPublicar a capacidade de integracao para que as equipas a possam descobrir, avaliar, solicitar acesso, concluir o onboarding, reutiliza-la e obter suporte.\n\nh3. Station questions\n* Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.\n* Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.\n* Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.\n* Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.\n* A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.\n\nh3. Other related resources\n* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.\n* *Modelo de contrato de serviço*: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.\n\nh2. 8. Monitorização e melhoria da integração\n\nMonitorize a fiabilidade da integração, a reutilização, os incidentes, o desempenho, os resultados dos consumidores e as necessidades de melhoria.\n\nh3. Station questions\n* Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).\n* Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.\n* Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.\n* Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.\n* A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.\n\nh3. Other related resources\n* *Métricas e análise de API*: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.\n* *Estratégias de envolvimento da comunidade API*: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social."
      },
      {
        "id": "automation-cycle:question-template-markdown",
        "cycleId": "automation-cycle",
        "kind": "questions",
        "format": "markdown",
        "title": "Ciclo de Automação question template Markdown",
        "body": "# Ciclo de Automação question template\n\nUm ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.\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. Estratégia da oportunidade de automação\n\nIdentifique e priorize oportunidades de automação por valor, viabilidade, risco, propriedade e impacto esperado no processo.\n\n### Canvas questions\n#### Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n- **Persona**: Quem é o cliente típico que passa por esta percurso?\n- **O cliente descobre a necessidade**: Como o cliente reconhece sua necessidade ou problema?\n- **Necessidade do cliente resolvida**: Como a necessidade do cliente é resolvida no final?\n- **Etapas da percurso**: Quais são as etapas que o cliente percorre em sua percurso?\n- **Dores**: Quais são os pontos fracos ou desafios do cliente?\n- **Ganhos**: Quais são os ganhos ou benefícios do cliente?\n- **Entradas e saídas**: Quais são as entradas e saídas em cada etapa?\n- **Regras de interação e processamento**: Quais são as regras de interação e processamento em cada etapa?\n\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas da Proposta de Valor da Capacidade\nQue capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?\n- **Tarefas e resultados dos utilizadores**: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?\n- **Funcionalidades da capacidade que permitem ganhos**: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?\n- **Funcionalidades da capacidade que aliviam dores**: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?\n- **Capacidades reutilizáveis**: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?\n\n## 2. Requisitos do processo e dos utilizadores\n\nRecolha utilizadores do processo, funções, transferências, exceções, restrições e expectativas de serviço antes de conceber a automação.\n\n### Canvas questions\n#### Canvas de Requisitos da Experiência do Utilizador\nQue requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?\n- **Objetivos dos utilizadores**: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?\n- **Disponibilidade e atualidade**: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?\n- **Volume e desempenho**: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?\n- **Qualidade e consistência dos dados**: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?\n- **Segurança, privacidade e conformidade**: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?\n- **Integração e acesso**: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?\n- **Mudança e controlo de versões**: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?\n- **Observabilidade e apoio**: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?\n- **Recuperação e continuidade**: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?\n- **Implicações de arquitetura**: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?\n\n## 3. Decisão de plataforma de automação\n\nEscolher a plataforma de automacao, o runtime, a abordagem de integracao, os controlos de governacao e as restricoes operacionais.\n\n### Canvas questions\n#### Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n- **Riscos de disponibilidade**: Quais são os riscos potenciais para a disponibilidade da API?\n- **Mitigar riscos de disponibilidade**: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n- **Riscos de segurança**: Quais são os riscos potenciais de segurança associados à API?\n- **Mitigar riscos de segurança**: Como o fornecedor da API pode mitigar os riscos de segurança?\n- **Riscos de dados**: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n- **Mitigar riscos de dados**: Como o fornecedor da API pode mitigar os riscos de dados?\n\n#### Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n- **Grupos de Localização / Confiança**: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n- **Características do grupo**: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n- **Locais / Zonas Relevantes**: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n- **Características de localização / zona**: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n- **Distâncias de Rede / Regulatórias**: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n- **Características da Distância**: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n- **Pontos de extremidade de conectividade**: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n- **Características de acesso aos pontos de extremidade**: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\n#### Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n- **Volumes de negócio atuais**: Quais são os volumes de negócio e as taxas de transação atuais?\n- **Tendências de consumo futuro**: Quais são as tendências de consumo futuro previstas?\n- **Requisitos de pico de carga e disponibilidade**: Quais são os requisitos de pico de carga e disponibilidade?\n- **Estratégias de cache**: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n- **Estratégias de limitação de pedidos**: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n- **Estratégias de dimensionamento**: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\n### Other related resources\n- **Guia de responsabilidade operacional da automatização**: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.\n\n## 4. Conceção do fluxo de trabalho de automação\n\nConceber o fluxo de trabalho de automacao, os gatilhos, os pontos de decisao, as integracoes, o tratamento de dados, os contratos de interface relevantes e os caminhos de excecao.\n\n### Canvas questions\n#### Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?\n- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?\n- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?\n- **Relações entre entidades**: Quais são as relações entre as entidades?\n- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\n#### Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n- **Interações CRUD**: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n- **Modelos de entrada e saída CRUD**: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n- **Processamento e validação CRUD**: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n- **Interações orientadas por consulta**: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n- **Modelos de entrada e saída orientados por consulta**: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n- **Processamento e validação orientados por consulta**: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n- **Interações orientadas por comando**: Quais comandos de alteração de estado são necessários, se houver?\n- **Modelos de entrada e saída orientados por comando**: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Processamento e validação orientados por comando**: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n- **Interações orientadas por eventos**: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n- **Modelos de entrada e saída orientados por eventos**: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n- **Processamento e validação orientados por eventos**: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\n### Other related resources\n- **Guia de desenho do processo e workflow**: Orientação para modelar passos do processo, papéis, passagens de responsabilidade, pontos de decisão, estados, entradas, saídas e exceções que moldam um workflow de automatização.\n- **Guia de decisões e regras de negócio**: Orientação para captar regras, limiares, decisões, aprovações, verificações de elegibilidade e responsabilidade pelas regras no desenho de automatizações.\n- **Guia de gatilhos, passagens de responsabilidade e exceções da automatização**: Orientação para definir gatilhos de automatização, passagens para intervenção humana, tratamento de exceções, tentativas repetidas, ações compensatórias e caminhos de escalamento de suporte.\n\n## 5. Entrega e operacao da automacao\n\nConstrua, teste, disponibilize, documente e opere a automação com propriedade, controlos e caminhos de reversão claros.\n\n### Station questions\n- Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.\n- Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.\n- Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.\n- Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.\n- Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.\n- Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n- Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.\n- Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.\n\n### Other related resources\n- **Guia de testes de automatização**: Orientação para testar workflows automatizados, decisões, integrações, exceções, comportamento de rollback, supervisão e impacto nos utilizadores antes da publicação.\n- **Guia de responsabilidade operacional da automatização**: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.\n- **Guia de rollback e supervisão da automatização**: Orientação para desenhar caminhos de rollback, pausa, substituição manual, monitorização, supervisão e recuperação para automatizações.\n\n## 6. Revisão de prontidão da automação\n\nReveja a prontidão, a qualidade, o risco, a conformidade, a supervisão humana, as evidências e os critérios de disponibilização da automação.\n\n### Station questions\n- Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.\n- Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.\n- Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.\n- Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.\n- As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.\n\n### Other related resources\n- **Checklist de prontidão da automatização**: Uma checklist para validar workflow de automatização, controlos, risco, conformidade, supervisão humana, evidências de teste, rollback, operações e prontidão para publicação.\n- **Boas práticas de conformidade da API**: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\n## 7. Rollout e enablement da automacao\n\nCapacite utilizadores e operadores com descoberta, integração, instruções operacionais, caminhos de suporte e comunicação de alterações.\n\n### Station questions\n- Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.\n- Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.\n- Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.\n- Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.\n- A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.\n\n### Other related resources\n- **Guia de rollout e enablement da automatização**: Orientação para implementar automatizações com comunicação aos utilizadores, onboarding, instruções operacionais, caminhos de suporte, gestão da mudança e ciclos de feedback.\n- **Modelo de contrato de serviço**: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.\n\n## 8. Monitorização e melhoria da automação\n\nMonitorize o desempenho da automação, exceções, fiabilidade, resultados dos utilizadores, impacto operacional e oportunidades de melhoria.\n\n### Station questions\n- Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).\n- Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.\n- Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.\n- Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.\n- A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.\n\n### Other related resources\n- **Guia de responsabilidade operacional da automatização**: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.\n- **Métricas e análise de API**: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio."
      },
      {
        "id": "automation-cycle:question-template-confluence-wiki",
        "cycleId": "automation-cycle",
        "kind": "questions",
        "format": "confluence-wiki",
        "title": "Ciclo de Automação question template Confluence wiki",
        "body": "h1. Ciclo de Automação question template\n\nUm ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.\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. Estratégia da oportunidade de automação\n\nIdentifique e priorize oportunidades de automação por valor, viabilidade, risco, propriedade e impacto esperado no processo.\n\nh3. Canvas questions\nh4. Canvas do Percurso do Cliente\nQual é a percurso do cliente ou parceiro que a API pretende apoiar?\n* *Persona*: Quem é o cliente típico que passa por esta percurso?\n* *O cliente descobre a necessidade*: Como o cliente reconhece sua necessidade ou problema?\n* *Necessidade do cliente resolvida*: Como a necessidade do cliente é resolvida no final?\n* *Etapas da percurso*: Quais são as etapas que o cliente percorre em sua percurso?\n* *Dores*: Quais são os pontos fracos ou desafios do cliente?\n* *Ganhos*: Quais são os ganhos ou benefícios do cliente?\n* *Entradas e saídas*: Quais são as entradas e saídas em cada etapa?\n* *Regras de interação e processamento*: Quais são as regras de interação e processamento em cada etapa?\n\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas da Proposta de Valor da Capacidade\nQue capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?\n* *Tarefas e resultados dos utilizadores*: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?\n* *Funcionalidades da capacidade que permitem ganhos*: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?\n* *Funcionalidades da capacidade que aliviam dores*: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?\n* *Capacidades reutilizáveis*: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?\n\nh2. 2. Requisitos do processo e dos utilizadores\n\nRecolha utilizadores do processo, funções, transferências, exceções, restrições e expectativas de serviço antes de conceber a automação.\n\nh3. Canvas questions\nh4. Canvas de Requisitos da Experiência do Utilizador\nQue requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?\n* *Objetivos dos utilizadores*: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?\n* *Disponibilidade e atualidade*: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?\n* *Volume e desempenho*: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?\n* *Qualidade e consistência dos dados*: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?\n* *Segurança, privacidade e conformidade*: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?\n* *Integração e acesso*: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?\n* *Mudança e controlo de versões*: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?\n* *Observabilidade e apoio*: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?\n* *Recuperação e continuidade*: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?\n* *Implicações de arquitetura*: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?\n\nh2. 3. Decisão de plataforma de automação\n\nEscolher a plataforma de automacao, o runtime, a abordagem de integracao, os controlos de governacao e as restricoes operacionais.\n\nh3. Canvas questions\nh4. Canvas de Impacto no Negócio\nQuais são os possíveis impactos no negócio da falha da API?\n* *Riscos de disponibilidade*: Quais são os riscos potenciais para a disponibilidade da API?\n* *Mitigar riscos de disponibilidade*: Como o fornecedor da API pode mitigar os riscos de disponibilidade?\n* *Riscos de segurança*: Quais são os riscos potenciais de segurança associados à API?\n* *Mitigar riscos de segurança*: Como o fornecedor da API pode mitigar os riscos de segurança?\n* *Riscos de dados*: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?\n* *Mitigar riscos de dados*: Como o fornecedor da API pode mitigar os riscos de dados?\n\nh4. Canvas de Localização\nQue fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?\n* *Grupos de Localização / Confiança*: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?\n* *Características do grupo*: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?\n* *Locais / Zonas Relevantes*: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?\n* *Características de localização / zona*: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?\n* *Distâncias de Rede / Regulatórias*: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?\n* *Características da Distância*: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?\n* *Pontos de extremidade de conectividade*: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?\n* *Características de acesso aos pontos de extremidade*: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?\n\nh4. Canvas de Capacidade\nQuanta capacidade é necessária para suportar o consumo da API?\n* *Volumes de negócio atuais*: Quais são os volumes de negócio e as taxas de transação atuais?\n* *Tendências de consumo futuro*: Quais são as tendências de consumo futuro previstas?\n* *Requisitos de pico de carga e disponibilidade*: Quais são os requisitos de pico de carga e disponibilidade?\n* *Estratégias de cache*: Quais estratégias de cache podem ser usadas para otimizar o desempenho?\n* *Estratégias de limitação de pedidos*: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?\n* *Estratégias de dimensionamento*: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?\n\nh3. Other related resources\n* *Guia de responsabilidade operacional da automatização*: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.\n\nh2. 4. Conceção do fluxo de trabalho de automação\n\nConceber o fluxo de trabalho de automacao, os gatilhos, os pontos de decisao, as integracoes, o tratamento de dados, os contratos de interface relevantes e os caminhos de excecao.\n\nh3. Canvas questions\nh4. Canvas de Domínio\nQuais são as entidades principais e as regras de negócio relacionadas com a API?\n* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?\n* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?\n* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?\n* *Relações entre entidades*: Quais são as relações entre as entidades?\n* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?\n* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?\n\nh4. Canvas de Interação\nQue tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?\n* *Interações CRUD*: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?\n* *Modelos de entrada e saída CRUD*: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?\n* *Processamento e validação CRUD*: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?\n* *Interações orientadas por consulta*: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?\n* *Modelos de entrada e saída orientados por consulta*: Quais são os modelos de entrada e saída para as interações orientadas por consulta?\n* *Processamento e validação orientados por consulta*: Quais são as regras de processamento e validação para as interações orientadas por consulta?\n* *Interações orientadas por comando*: Quais comandos de alteração de estado são necessários, se houver?\n* *Modelos de entrada e saída orientados por comando*: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Processamento e validação orientados por comando*: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?\n* *Interações orientadas por eventos*: Quais eventos precisam /de ser publicados ou consumidos, se houver?\n* *Modelos de entrada e saída orientados por eventos*: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?\n* *Processamento e validação orientados por eventos*: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?\n\nh3. Other related resources\n* *Guia de desenho do processo e workflow*: Orientação para modelar passos do processo, papéis, passagens de responsabilidade, pontos de decisão, estados, entradas, saídas e exceções que moldam um workflow de automatização.\n* *Guia de decisões e regras de negócio*: Orientação para captar regras, limiares, decisões, aprovações, verificações de elegibilidade e responsabilidade pelas regras no desenho de automatizações.\n* *Guia de gatilhos, passagens de responsabilidade e exceções da automatização*: Orientação para definir gatilhos de automatização, passagens para intervenção humana, tratamento de exceções, tentativas repetidas, ações compensatórias e caminhos de escalamento de suporte.\n\nh2. 5. Entrega e operacao da automacao\n\nConstrua, teste, disponibilize, documente e opere a automação com propriedade, controlos e caminhos de reversão claros.\n\nh3. Station questions\n* Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.\n* Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.\n* Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.\n* Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.\n* Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.\n* Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.\n* Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.\n* Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.\n\nh3. Other related resources\n* *Guia de testes de automatização*: Orientação para testar workflows automatizados, decisões, integrações, exceções, comportamento de rollback, supervisão e impacto nos utilizadores antes da publicação.\n* *Guia de responsabilidade operacional da automatização*: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.\n* *Guia de rollback e supervisão da automatização*: Orientação para desenhar caminhos de rollback, pausa, substituição manual, monitorização, supervisão e recuperação para automatizações.\n\nh2. 6. Revisão de prontidão da automação\n\nReveja a prontidão, a qualidade, o risco, a conformidade, a supervisão humana, as evidências e os critérios de disponibilização da automação.\n\nh3. Station questions\n* Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.\n* Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.\n* Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.\n* Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.\n* As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.\n\nh3. Other related resources\n* *Checklist de prontidão da automatização*: Uma checklist para validar workflow de automatização, controlos, risco, conformidade, supervisão humana, evidências de teste, rollback, operações e prontidão para publicação.\n* *Boas práticas de conformidade da API*: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.\n\nh2. 7. Rollout e enablement da automacao\n\nCapacite utilizadores e operadores com descoberta, integração, instruções operacionais, caminhos de suporte e comunicação de alterações.\n\nh3. Station questions\n* Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API.\n* Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo.\n* Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores.\n* Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade.\n* A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz.\n\nh3. Other related resources\n* *Guia de rollout e enablement da automatização*: Orientação para implementar automatizações com comunicação aos utilizadores, onboarding, instruções operacionais, caminhos de suporte, gestão da mudança e ciclos de feedback.\n* *Modelo de contrato de serviço*: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.\n\nh2. 8. Monitorização e melhoria da automação\n\nMonitorize o desempenho da automação, exceções, fiabilidade, resultados dos utilizadores, impacto operacional e oportunidades de melhoria.\n\nh3. Station questions\n* Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).\n* Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.\n* Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.\n* Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.\n* A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.\n\nh3. Other related resources\n* *Guia de responsabilidade operacional da automatização*: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.\n* *Métricas e análise de API*: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio."
      }
    ]
  }
}