重构:文件系统模块化架构,优化应用启动流程
This commit is contained in:
109
docs/04-功能迭代/GO-DESK-2.数据库客户端/设计文档/README.md
Normal file
109
docs/04-功能迭代/GO-DESK-2.数据库客户端/设计文档/README.md
Normal file
@@ -0,0 +1,109 @@
|
||||
# 设计文档
|
||||
|
||||
## 目录说明
|
||||
|
||||
设计文档用于存储功能设计、架构设计等设计相关文档。
|
||||
|
||||
### 核心原则
|
||||
|
||||
1. **抽象与实现分离**:设计文档描述"做什么"和"为什么",不描述"怎么做"
|
||||
2. **引用知识库**:设计文档应引用知识库中的规范和参考
|
||||
3. **关联决策**:设计文档应关联相关的决策记录(ADR)
|
||||
|
||||
---
|
||||
|
||||
## 📋 需求设计
|
||||
|
||||
**位置**:`需求设计/`
|
||||
**用途**:功能需求、业务需求
|
||||
|
||||
### 文档类型
|
||||
- 功能需求文档
|
||||
- 数据库类型差异分析
|
||||
- 业务规则说明
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ 架构设计
|
||||
|
||||
**位置**:`架构设计/`
|
||||
**用途**:系统架构、组件架构设计
|
||||
|
||||
### 文档类型
|
||||
- 前端架构设计
|
||||
- 后端架构设计
|
||||
- 事件系统设计
|
||||
- 右键菜单系统设计
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ 功能设计
|
||||
|
||||
**位置**:`功能设计/`
|
||||
**用途**:具体功能的设计文档
|
||||
|
||||
### 文档类型
|
||||
- 表结构查看功能设计
|
||||
- 多表结构查看方案分析
|
||||
- 待讨论问题汇总
|
||||
|
||||
---
|
||||
|
||||
## 🎨 样式设计
|
||||
|
||||
**位置**:根目录
|
||||
**用途**:前端布局和样式系统设计
|
||||
|
||||
### 文档类型
|
||||
- 前端布局样式系统设计
|
||||
|
||||
---
|
||||
|
||||
## 📝 设计文档模板
|
||||
|
||||
### 功能设计模板
|
||||
|
||||
```markdown
|
||||
# {功能名称}设计
|
||||
|
||||
**状态**:{设计中|已完成|已废弃}
|
||||
**创建日期**:YYYY-MM-DD
|
||||
**最后更新**:YYYY-MM-DD
|
||||
|
||||
## 一、设计目标
|
||||
|
||||
功能要解决什么问题?
|
||||
|
||||
## 二、设计约束
|
||||
|
||||
引用:[知识库/规范/编码规范.md](../../知识库/规范/编码规范.md)
|
||||
|
||||
## 三、设计方案
|
||||
|
||||
### 3.1 方案概述
|
||||
|
||||
### 3.2 详细设计
|
||||
|
||||
## 四、相关决策
|
||||
|
||||
- [ADR-{序号}](../../决策记录/ADR-{序号}.md)
|
||||
|
||||
## 五、待讨论问题
|
||||
|
||||
- [问题追踪/待讨论/{问题}.md](../../问题追踪/待讨论/{问题}.md)
|
||||
|
||||
## 六、实现计划
|
||||
|
||||
1. 步骤1
|
||||
2. 步骤2
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 关联关系
|
||||
|
||||
设计文档应明确关联:
|
||||
- **知识库**:引用的规范和参考
|
||||
- **决策记录**:相关的架构决策
|
||||
- **问题追踪**:待讨论和待实现的问题
|
||||
|
||||
Reference in New Issue
Block a user