Skip to content

ARCHITECTURE.md 模板


系统概览

[用 2-3 句话描述系统的核心职责和边界。]


分层架构

层级定义

层级目录职责不允许做什么
Typessrc/types/类型定义和接口不允许有任何业务逻辑
Configsrc/config/配置管理只能依赖 Types
Repositorysrc/repository/数据访问不允许有业务规则
Servicesrc/services/业务逻辑不允许直接访问数据库
Runtimesrc/[routes/api]/HTTP 处理不允许有业务逻辑
UIsrc/components/界面渲染不允许直接调用数据库

依赖方向

Types → Config → Repository → Service → Runtime → UI

依赖只能向右(向上层流动),绝不允许反向。


核心技术选型

技术选型原因决策记录
数据库[选型][一句话原因][ADR 链接]
状态管理[选型][一句话原因][ADR 链接]

API 约定

响应格式

typescript
interface ApiResponse<T> {
  success: boolean;
  data?: T;
  error?: {
    code: string;
    message: string;
  };
}

关键约束

  1. [约束 1]:[描述]
  2. [约束 2]:[描述]

Released under the MIT License.