feat: add frontend development guidelines and structure documentation

- Introduced API guidelines for interface contracts and request handling.
- Added design tokens usage guidelines for consistent styling across the project.
- Established DTO guidelines for defining request parameters and response data types.
- Created frontend structure guidelines to clarify directory organization and code placement rules.
- Compiled a comprehensive frontend development guideline document covering various aspects of the development process.
- Implemented quality guidelines to ensure code maintainability and adherence to best practices.
This commit is contained in:
yuxuanhui
2026-07-25 22:20:25 +08:00
commit 91861565bb
78 changed files with 5001 additions and 0 deletions
+38
View File
@@ -0,0 +1,38 @@
---
id: DR-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: development-requirement
stage: development-requirement
owner_role: SE
status: draft
source_ids:
- OR-yyyymmdd-nnn
derived_ids: []
skill:
name: se-requirement-analysis
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# DR:研发需求
## 功能需求
## 非功能需求
## 接口需求
## 数据需求
## 权限与安全
## 兼容性
## 依赖
## 观测与日志
## 发布与回滚
## 来源映射
+45
View File
@@ -0,0 +1,45 @@
---
id: DS-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: design-specification
stage: detailed-design
owner_role: RD
status: draft
source_ids:
- OR-yyyymmdd-nnn
- DR-yyyymmdd-nnn
derived_ids: []
skill:
name: rd-design-generate
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# DS:详细设计
## 背景
## 影响范围
## 模块拆分
## 接口设计
## 数据设计
## 状态流
## 异常处理
## 权限与安全
## 兼容性与迁移
## 观测与日志
## 开发任务拆分
## 测试点
## 风险与待确认
+30
View File
@@ -0,0 +1,30 @@
---
id: INTAKE-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: intake
stage: user-requirement
owner_role: PM
status: draft
source_ids: []
derived_ids: []
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# 原始输入
## 背景
## 原始描述
## 目标用户
## 当前问题
## 期望结果
## 约束
## 已知材料
## 待确认问题
+34
View File
@@ -0,0 +1,34 @@
---
id: OR-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: objective-requirement
stage: development-requirement
owner_role: SE
status: draft
source_ids:
- UR-yyyymmdd-nnn
- RA-yyyymmdd-nnn
- SA-yyyymmdd-nnn
derived_ids: []
skill:
name: se-requirement-analysis
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# OR:研发目标需求
## 工程目标
## 交付范围
## 成功标准
## 约束
## 非目标
## 风险
## 来源映射
@@ -0,0 +1,36 @@
---
id: RA-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: requirement-analysis
stage: user-requirement
owner_role: PM
status: draft
source_ids:
- UR-yyyymmdd-nnn
derived_ids: []
skill:
name: pm-requirement-refine
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# 需求分析
## 问题拆解
## 用户/业务价值
## 功能需求
## 非功能关注点
## 约束
## 依赖
## 风险
## 决策点
## 待确认问题
@@ -0,0 +1,33 @@
---
id: SA-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: scenario-analysis
stage: user-requirement
owner_role: PM
status: draft
source_ids:
- UR-yyyymmdd-nnn
- RA-yyyymmdd-nnn
derived_ids: []
skill:
name: pm-requirement-refine
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# 场景分析
## 主场景
## 替代场景
## 异常场景
## 边界场景
## 角色与权限
## 数据变化
## 验收标准映射
+26
View File
@@ -0,0 +1,26 @@
---
id: TC-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: test-case
stage: test
owner_role: QA
status: draft
source_ids:
- TP-yyyymmdd-nnn
derived_ids: []
skill:
name: test-case-generate
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# 测试用例
| 用例 ID | 类型 | 来源 ID | 前置条件 | 步骤 | 预期结果 | 优先级 |
| --- | --- | --- | --- | --- | --- | --- |
| TC-yyyymmdd-001 | positive | DR-yyyymmdd-nnn | | | | P0 |
## 覆盖缺口
## 风险说明
+39
View File
@@ -0,0 +1,39 @@
---
id: TP-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: test-plan
stage: test
owner_role: QA
status: draft
source_ids:
- UR-yyyymmdd-nnn
- OR-yyyymmdd-nnn
- DR-yyyymmdd-nnn
- DS-yyyymmdd-nnn
derived_ids: []
skill:
name: test-case-generate
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# 测试计划
## 测试范围
## 非测试范围
## 测试策略
## 测试环境
## 测试数据
## 准入条件
## 准出条件
## 风险
## 覆盖矩阵
@@ -0,0 +1,38 @@
---
id: UR-yyyymmdd-nnn
case_id: REQ-yyyymmdd-nnn-short-name
type: user-requirement
stage: user-requirement
owner_role: PM
status: draft
source_ids:
- INTAKE-yyyymmdd-nnn
derived_ids: []
skill:
name: pm-requirement-refine
version: 0.1.0
created: yyyy-mm-dd
updated: yyyy-mm-dd
---
# 用户需求
## 一句话需求
## 用户目标
## 业务价值
## 范围
### 包含
### 不包含
## 验收方向
## 优先级
## 假设
## 待确认问题