sc-design

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

System & Component Design Skill

系统与组件设计Skill

Architecture planning and interface design with industry best practices.
基于行业最佳实践的架构规划与接口设计。

Quick Start

快速开始

bash
undefined
bash
undefined

Architecture design

架构设计

/sc:design [target] --type architecture
/sc:design [target] --type architecture

API specification

API 规范

/sc:design payment-api --type api --format spec
/sc:design payment-api --type api --format spec

Database schema

数据库 Schema

/sc:design e-commerce --type database --format diagram
undefined
/sc:design e-commerce --type database --format diagram
undefined

Behavioral Flow

行为流程

  1. Analyze - Examine requirements and existing system context
  2. Plan - Define design approach based on type and format
  3. Design - Create specifications with best practices
  4. Validate - Ensure maintainability and scalability
  5. Document - Generate diagrams and specifications
  1. 分析 - 审视需求与现有系统环境
  2. 规划 - 根据类型与格式定义设计方法
  3. 设计 - 遵循最佳实践创建规范
  4. 验证 - 确保可维护性与可扩展性
  5. 文档化 - 生成图表与规范文档

Flags

标志参数

FlagTypeDefaultDescription
--type
stringarchitecturearchitecture, api, component, database
--format
stringspecdiagram, spec, code
标志类型默认值描述
--type
字符串architecture可选值:architecture、api、component、database
--format
字符串spec可选值:diagram、spec、code

Evidence Requirements

证据要求

This skill does NOT require hard evidence. Deliverables are:
  • Design specifications and diagrams
  • Interface definitions
  • Schema documentation
本Skill无需硬性证据。交付物包括:
  • 设计规范与图表
  • 接口定义
  • Schema文档

Design Types

设计类型

Architecture (
--type architecture
)

架构(
--type architecture

  • System structure and component relationships
  • Scalability and reliability patterns
  • Service boundaries and communication
  • 系统结构与组件关系
  • 可扩展性与可靠性模式
  • 服务边界与通信机制

API (
--type api
)

API(
--type api

  • RESTful/GraphQL endpoint design
  • Request/response schemas
  • Authentication and versioning
  • RESTful/GraphQL 端点设计
  • 请求/响应 Schema
  • 认证与版本控制

Component (
--type component
)

组件(
--type component

  • Interface contracts and dependencies
  • State management patterns
  • Integration points
  • 接口契约与依赖关系
  • 状态管理模式
  • 集成点

Database (
--type database
)

数据库(
--type database

  • Entity relationships and constraints
  • Normalization and indexing
  • Performance considerations
  • 实体关系与约束
  • 规范化与索引
  • 性能考量

Output Formats

输出格式

Diagram (
--format diagram
)

图表(
--format diagram

  • ASCII or Mermaid diagrams
  • Component relationship visualization
  • Data flow representation
  • ASCII 或 Mermaid 图表
  • 组件关系可视化
  • 数据流展示

Specification (
--format spec
)

规范文档(
--format spec

  • OpenAPI/Swagger for APIs
  • Detailed interface documentation
  • Technical requirements
  • API 对应的 OpenAPI/Swagger 文档
  • 详细的接口文档
  • 技术要求

Code (
--format code
)

代码(
--format code

  • Interface definitions
  • Type declarations
  • Skeleton implementations
  • 接口定义
  • 类型声明
  • 骨架实现

Examples

示例

System Architecture

系统架构

/sc:design user-management --type architecture --format diagram
/sc:design user-management --type architecture --format diagram

Component relationships, data flow, scalability patterns

组件关系、数据流、可扩展性模式

undefined
undefined

API Design

API 设计

/sc:design payment-api --type api --format spec
/sc:design payment-api --type api --format spec

OpenAPI spec with endpoints, schemas, auth patterns

包含端点、Schema、认证模式的 OpenAPI 规范

undefined
undefined

Component Interface

组件接口

/sc:design notification-service --type component --format code
/sc:design notification-service --type component --format code

TypeScript/Python interfaces with clear contracts

具备清晰契约的 TypeScript/Python 接口

undefined
undefined

Database Schema

数据库 Schema

/sc:design inventory-db --type database --format diagram
/sc:design inventory-db --type database --format diagram

ER diagrams with relationships and constraints

包含关系与约束的 ER 图

undefined
undefined

MCP Integration

MCP 集成

PAL MCP (Design Validation)

PAL MCP(设计验证)

ToolWhen to UsePurpose
mcp__pal__planner
Architecture planningSequential planning with branching for design decisions
mcp__pal__consensus
Design decisionsMulti-model validation of architectural choices
mcp__pal__thinkdeep
Complex systemsDeep analysis of system requirements
mcp__pal__chat
BrainstormingCollaborative design exploration
mcp__pal__apilookup
API standardsGet current API design best practices
工具使用场景用途
mcp__pal__planner
架构规划为设计决策提供带分支的顺序规划
mcp__pal__consensus
设计决策对架构选择进行多模型验证
mcp__pal__thinkdeep
复杂系统深度分析系统需求
mcp__pal__chat
头脑风暴协作式设计探索
mcp__pal__apilookup
API 标准获取当前 API 设计最佳实践

PAL Usage Patterns

PAL 使用模式

bash
undefined
bash
undefined

Architecture planning

架构规划

mcp__pal__planner( step="Designing microservices architecture for e-commerce platform", step_number=1, total_steps=4, more_steps_needed=True )
mcp__pal__planner( step="Designing microservices architecture for e-commerce platform", step_number=1, total_steps=4, more_steps_needed=True )

Validate design with consensus

用共识机制验证设计

mcp__pal__consensus( models=[ {"model": "gpt-5.2", "stance": "for"}, {"model": "gemini-3-pro", "stance": "against"}, {"model": "deepseek", "stance": "neutral"} ], step="Evaluate: Should we use event sourcing for the order management system?" )
mcp__pal__consensus( models=[ {"model": "gpt-5.2", "stance": "for"}, {"model": "gemini-3-pro", "stance": "against"}, {"model": "deepseek", "stance": "neutral"} ], step="Evaluate: Should we use event sourcing for the order management system?" )

Deep system analysis

深度系统分析

mcp__pal__thinkdeep( step="Analyzing scalability requirements for real-time notification system", hypothesis="WebSocket with Redis pub/sub will handle 100k concurrent users", confidence="medium", focus_areas=["scalability", "reliability", "performance"] )
undefined
mcp__pal__thinkdeep( step="Analyzing scalability requirements for real-time notification system", hypothesis="WebSocket with Redis pub/sub will handle 100k concurrent users", confidence="medium", focus_areas=["scalability", "reliability", "performance"] )
undefined

Rube MCP (Documentation & Collaboration)

Rube MCP(文档与协作)

ToolWhen to UsePurpose
mcp__rube__RUBE_SEARCH_TOOLS
External toolsFind diagramming, documentation tools
mcp__rube__RUBE_MULTI_EXECUTE_TOOL
Share designsPost to Notion, Confluence, Slack
mcp__rube__RUBE_CREATE_UPDATE_RECIPE
Design workflowsSave reusable design processes
工具使用场景用途
mcp__rube__RUBE_SEARCH_TOOLS
外部工具调用查找绘图、文档工具
mcp__rube__RUBE_MULTI_EXECUTE_TOOL
设计分享发布至 Notion、Confluence、Slack
mcp__rube__RUBE_CREATE_UPDATE_RECIPE
设计工作流保存可复用的设计流程

Rube Usage Patterns

Rube 使用模式

bash
undefined
bash
undefined

Create design document in Notion

在 Notion 中创建设计文档

mcp__rube__RUBE_SEARCH_TOOLS(queries=[ {"use_case": "create notion page", "known_fields": "database:Architecture"} ])
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[ {"tool_slug": "NOTION_CREATE_PAGE", "arguments": { "title": "Payment API Design v2", "content": "## Overview\n..." }} ])
mcp__rube__RUBE_SEARCH_TOOLS(queries=[ {"use_case": "create notion page", "known_fields": "database:Architecture"} ])
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[ {"tool_slug": "NOTION_CREATE_PAGE", "arguments": { "title": "Payment API Design v2", "content": "## Overview\n..." }} ])

Share design for review

分享设计以供评审

mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[ {"tool_slug": "SLACK_SEND_MESSAGE", "arguments": { "channel": "#architecture", "text": "New design ready for review: Payment API v2" }}, {"tool_slug": "JIRA_CREATE_ISSUE", "arguments": { "project": "ARCH", "summary": "Review: Payment API Design", "issue_type": "Task" }} ])
undefined
mcp__rube__RUBE_MULTI_EXECUTE_TOOL(tools=[ {"tool_slug": "SLACK_SEND_MESSAGE", "arguments": { "channel": "#architecture", "text": "New design ready for review: Payment API v2" }}, {"tool_slug": "JIRA_CREATE_ISSUE", "arguments": { "project": "ARCH", "summary": "Review: Payment API Design", "issue_type": "Task" }} ])
undefined

Flags (Extended)

扩展标志参数

FlagTypeDefaultDescription
--pal-plan
boolfalseUse PAL planner for systematic design
--consensus
boolfalseValidate design with multi-model consensus
--share
string-Share via Rube (notion, confluence, slack)
--create-ticket
boolfalseCreate review ticket via Rube
标志类型默认值描述
--pal-plan
布尔值false使用 PAL planner 进行系统化设计
--consensus
布尔值false通过多模型共识验证设计
--share
字符串-通过 Rube 分享至指定平台(notion、confluence、slack)
--create-ticket
布尔值false通过 Rube 创建评审工单

Tool Coordination

工具协同

  • Read - Requirements analysis
  • Grep/Glob - Pattern analysis
  • Write - Design documentation
  • Bash - External tool integration
  • PAL MCP - Design planning, consensus validation, deep analysis
  • Rube MCP - Documentation sharing, collaboration, review workflows
  • Read - 需求分析
  • Grep/Glob - 模式分析
  • Write - 设计文档编写
  • Bash - 外部工具集成
  • PAL MCP - 设计规划、共识验证、深度分析
  • Rube MCP - 文档分享、协作、评审工作流