technical-integrations

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Technical Integrations

技术集成

Purpose

目标

Design and review external-vendor integrations using existing internal patterns, with vendor/framework-agnostic workflows for API, RFC, SDK, and rollout planning.
利用现有内部模式设计并评审外部供应商集成,制定与供应商/框架无关的API、RFC、SDK及上线规划工作流。

When to use

适用场景

  • Adding a new third-party/vendor integration.
  • Evolving an existing integration surface without breaking compatibility.
  • Writing or reviewing integration RFCs before implementation.
  • Defining SDK/API integration points and delivery plans.
  • 添加新的第三方/供应商集成
  • 在不破坏兼容性的前提下升级现有集成接口
  • 在实施前编写或评审集成RFC
  • 定义SDK/API集成点及交付方案

Workflow

工作流程

  1. Classify mode:
    discover
    ,
    design
    ,
    review
    , or
    implementation-plan
    .
  2. Run
    references/hunt-and-inventory.md
    to gather current integration evidence and patterns.
  3. Use
    references/principles.md
    to enforce vendor/framework-agnostic constraints.
  4. For architecture and proposal work, follow
    references/design-and-rfc.md
    .
  5. For execution sequencing, follow
    references/implementation-plan.md
    .
  6. For QA pass, apply
    references/review-checklist.md
    .
  7. Return deliverables with explicit decisions, tradeoffs, and open risks.
  1. 分类模式:
    discover
    design
    review
    implementation-plan
  2. 执行
    references/hunt-and-inventory.md
    以收集当前集成的实例与模式
  3. 参考
    references/principles.md
    来遵循与供应商/框架无关的约束条件
  4. 架构与提案工作需遵循
    references/design-and-rfc.md
  5. 执行顺序规划需遵循
    references/implementation-plan.md
  6. QA环节需使用
    references/review-checklist.md
  7. 交付成果需明确包含决策、权衡方案及未解决的风险

Inputs

输入信息

  • Integration objective and target vendor capability.
  • Existing repo patterns (API, SDK, auth, observability, error model).
  • Compatibility constraints (backward compatibility, versioning, rollout policy).
  • Scope (discovery only, RFC draft, implementation plan, or full review).
  • 集成目标及目标供应商的能力
  • 现有代码库模式(API、SDK、认证、可观测性、错误模型)
  • 兼容性约束(向后兼容、版本控制、上线策略)
  • 范围(仅发现、RFC草案、实施规划或完整评审)

Outputs

输出成果

  • Integration inventory and pattern baseline.
  • RFC-quality proposal with options and decision rationale.
  • API and SDK integration design plan.
  • Validation and rollout checklist with unresolved risks.
  • 集成清单及模式基准
  • 达到RFC质量的提案,包含可选方案及决策依据
  • API与SDK集成设计方案
  • 包含未解决风险的验证及上线检查清单