Back to Details

ark-architecture

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Ark Architecture Skill

Ark架构Skill

Design architecture for Ark features following existing patterns and principles.
遵循现有模式和原则设计Ark功能的架构。

Process

流程

  1. Analyze Current Solution - Use the ark-analysis skill to examine relevant parts of the codebase
  2. Identify Patterns - Find existing idioms, data models, and service structures to reuse
  3. Design for Reuse - Extend existing components rather than creating new ones
  4. Enable Incremental Updates - Break changes into small, independent pieces
  5. Flag One-Way Decisions - Raise questions on choices that are hard to reverse
  1. 分析当前方案 - 使用ark-analysis skill检查代码库的相关部分
  2. 识别模式 - 找出可复用的现有惯用写法、数据模型和服务结构
  3. 为复用而设计 - 扩展现有组件而非创建新组件
  4. 支持增量更新 - 将变更拆分为小型、独立的模块
  5. 标记不可逆决策 - 对难以撤销的选择提出疑问

Principles

原则

  • Reuse over creation - Extend existing services, models, and patterns
  • Follow existing idioms - Match current code style, naming, and structure
  • Incremental delivery - Design so features can be shipped in stages
  • Reversibility - Identify and question decisions that lock in future options
  • 复用优先于创建 - 扩展现有服务、模型和模式
  • 遵循现有惯用写法 - 匹配当前的代码风格、命名和结构
  • 增量交付 - 设计时确保功能可分阶段上线
  • 可撤销性 - 识别并质疑会限制未来选择的决策

Conventions

约定

  • Watch endpoints: Use 
    ?watch=true
    query param for SSE streaming (Kubernetes-style)
  • Service ports: Use named ports (e.g., 
    port: mcp
    ) rather than port numbers
  • 监听端点：使用
    ?watch=true
    查询参数实现SSE流（Kubernetes-style）
  • 服务端口：使用命名端口（例如
    port: mcp
    ）而非端口号

Output

输出

Architecture documents should include:
  • Component diagram showing how new pieces fit with existing ones
  • Data model extending current schemas
  • API design following existing conventions
  • List of one-way decisions requiring team input
  • Implementation phases for incremental delivery
架构文档应包含：
  • 展示新模块与现有组件适配方式的组件图
  • 扩展当前模式的数据模型
  • 遵循现有约定的API设计
  • 需要团队参与的不可逆决策列表
  • 用于增量交付的实施阶段规划