130 lines
4.5 KiB
Markdown
130 lines
4.5 KiB
Markdown
# 数据库客户端模块
|
||
|
||
**模块状态**：开发中
|
||
**最后更新**：2025-01-28
|
||
|
||
---
|
||
|
||
## 📋 快速导航
|
||
|
||
| 类型 | 文档 | 说明 |
|
||
|------|------|------|
|
||
| 🎯 **MVP** | [设计文档/MVP规划.md](./设计文档/MVP规划.md) | **MVP规划（当前重点）** |
|
||
| 🎯 **决策** | [决策记录/](./决策记录/) | 架构决策、设计决策记录 |
|
||
| 📚 **知识库** | [知识库/](./知识库/) | 已确定的知识、规范、参考 |
|
||
| ❓ **问题** | [问题追踪/](./问题追踪/) | 待解决问题、讨论议题 |
|
||
| 📐 **设计** | [设计文档/](./设计文档/) | 功能设计、架构设计 |
|
||
| ✅ **检查** | [核对报告/](./核对报告/) | 检查报告（综合检查、功能实现检查、BUG报告） |
|
||
| 🧪 **测试** | [测试用例/](./测试用例/) | 测试用例和测试检查 |
|
||
|
||
## 🚀 MVP状态
|
||
|
||
**✅ 当前版本已达到MVP标准，可以发布MVP v1.0版本**
|
||
|
||
详细状态和检查结果请参考：
|
||
- [MVP规划.md](./设计文档/MVP规划.md) - MVP功能规划
|
||
- [MVP开发路线图.md](./设计文档/MVP开发路线图.md) - 开发路线图
|
||
- [MVP发布检查.md](./核对报告/MVP发布检查.md) - 发布检查报告（包含功能清单、质量检查、发布决策）
|
||
|
||
---
|
||
|
||
## 🎯 核心原则（确定性约束）
|
||
|
||
### 设计原则
|
||
- **抽象与实现分离**：设计文档只描述"做什么"和"为什么"，不描述"怎么做"
|
||
- **问题与知识分离**：待讨论问题单独管理，已确定知识进入知识库
|
||
- **决策可追溯**：所有设计决策都有明确的决策记录（ADR）
|
||
- **约束明确化**：所有约束条件明确记录，避免经验差异
|
||
|
||
### 协作规范
|
||
- **确定性先行**：优先明确约束和规则，再讨论具体实现
|
||
- **全程可控**：每个步骤都有明确的检查点和验证标准
|
||
- **异步有序**：通过文档结构支持异步协作，减少同步沟通成本
|
||
|
||
---
|
||
|
||
## 📁 文档结构说明
|
||
|
||
### 1. 决策记录（ADR）
|
||
**位置**：`决策记录/`
|
||
**用途**：记录所有架构和设计决策，包括决策背景、选项、选择理由
|
||
**格式**：标准ADR格式，包含状态、上下文、决策、后果
|
||
|
||
### 2. 知识库
|
||
**位置**：`知识库/`
|
||
**用途**：存储已确定的知识、规范、最佳实践
|
||
**分类**：
|
||
- `规范/` - 编码规范、命名规范、架构规范
|
||
- `参考/` - 技术参考、API参考、模式
|
||
- `最佳实践/` - 已验证的最佳实践
|
||
|
||
### 3. 问题追踪
|
||
**位置**：`问题追踪/`
|
||
**用途**：管理待解决问题、讨论议题、技术债务
|
||
**分类**：
|
||
- `待讨论/` - 需要讨论的问题
|
||
- `待实现/` - 已确定但未实现的功能
|
||
- `技术债务/` - 已知的技术债务
|
||
|
||
### 4. 设计文档
|
||
**位置**：`设计文档/`
|
||
**用途**：功能设计、架构设计文档
|
||
**分类**：
|
||
- `需求设计/` - 功能需求
|
||
- `架构设计/` - 系统架构
|
||
- `功能设计/` - 具体功能设计
|
||
|
||
### 5. 核对报告
|
||
**位置**：`核对报告/`
|
||
**用途**：各种检查报告、验证结果
|
||
|
||
### 6. 测试用例
|
||
**位置**：`测试用例/`
|
||
**用途**：测试用例、测试检查情况
|
||
|
||
---
|
||
|
||
## 🔍 使用指南
|
||
|
||
### 对于开发者
|
||
1. **开始新功能**：先查看 [知识库/规范/](./知识库/规范/) 了解约束
|
||
2. **遇到问题**：在 [问题追踪/](./问题追踪/) 中查找或创建问题
|
||
3. **做决策**：在 [决策记录/](./决策记录/) 中记录决策
|
||
4. **设计功能**：在 [设计文档/](./设计文档/) 中编写设计文档
|
||
|
||
### 对于AI助手
|
||
1. **读取约束**：优先读取 [知识库/规范/](./知识库/规范/) 中的约束
|
||
2. **检查决策**：在 [决策记录/](./决策记录/) 中查找相关决策
|
||
3. **处理问题**：在 [问题追踪/](./问题追踪/) 中查找待解决问题
|
||
4. **参考设计**：在 [设计文档/](./设计文档/) 中查找设计文档
|
||
|
||
### 下一步行动
|
||
- **立即行动**：查看 [行动建议.md](./行动建议.md) 了解下一步计划
|
||
- **当前重点**：解决 [问题-001](./问题追踪/待讨论/问题-001-右键菜单实现方式.md)
|
||
|
||
---
|
||
|
||
## 📊 模块状态
|
||
|
||
### 已完成 ✅
|
||
- 核心功能：连接管理、SQL编辑器、查询执行
|
||
- 表结构查看：MySQL、MongoDB、Redis
|
||
- ~~书签和模板管理~~（已删除）
|
||
|
||
### 进行中 🔄
|
||
- 右键菜单系统实现
|
||
- 表结构编辑功能
|
||
|
||
### 计划中 📋
|
||
- 多数据库类型支持扩展
|
||
- 性能优化
|
||
|
||
---
|
||
|
||
## 🔗 相关链接
|
||
|
||
- [任务规划](./任务规划.md) - 任务规划概览
|
||
- [决策记录](./决策记录/) - 所有设计决策
|
||
- [知识库](./知识库/) - 已确定的知识和规范
|
||
- [问题追踪](./问题追踪/) - 待解决问题
|