184 lines
7.6 KiB
Markdown
184 lines
7.6 KiB
Markdown
# 家具开品平台 - 文档导航
|
||
|
||
> **最后更新**:2026-03-31
|
||
> **项目状态**:新平台一期骨架已落地,旧 `CAD -> 装配步骤` 链继续作为兼容链保留
|
||
|
||
---
|
||
|
||
## 📖 快速导航
|
||
|
||
### 🎯 了解项目进度
|
||
- **[项目总览](./项目总览.md)** - 查看整体进度、功能完成度、下一步计划
|
||
- **[长期决策日志](./agent-memory/decision-log.md)** - 查看最近做过的重要技术与流程决策
|
||
- **[长期待办与阻塞](./agent-memory/open-issues.md)** - 查看当前仍在收口的问题
|
||
|
||
### 🏗️ 架构设计
|
||
- **[认证系统设计](./架构设计/auth-system-design.md)** - 用户认证和首次登录流程
|
||
- **[权限系统设计](./架构设计/permission-design-v2.md)** - 6 种角色的权限体系
|
||
|
||
### 📚 开发指南
|
||
- **[设计系统](./开发指南/设计指南.md)** - Apple 风格 UI 组件使用
|
||
- **[组件使用指南](./开发指南/组件使用指南.md)** - 常用组件的使用方法
|
||
- **[上传 API 指南](./开发指南/上传API指南.md)** - 文件上传功能使用
|
||
- **[性能优化指南](./开发指南/性能优化指南.md)** - 性能优化最佳实践
|
||
- **[数据库优化](./开发指南/数据库优化.md)** - 数据库查询优化
|
||
- **[快速测试指南](./开发指南/快速测试指南.md)** - 测试相关指南
|
||
- **[项目上下文](./agent-memory/project-context.md)** - 当前高频回归点、默认工作流、项目目标
|
||
|
||
### 🤝 团队协作
|
||
- **[团队协作模式](./workflow/团队协作模式.md)** - 当前推荐分工、分支规则、提交流程
|
||
- **[高频协作五条铁律](./workflow/高频协作五条铁律.md)** - 双 Codex 高频协作时的 5 条固定规则
|
||
- **[主线同步操作手册](./workflow/主线同步操作手册.md)** - 主线持续更新时,同事如何安全同步自己的分支
|
||
- **[同事本地 AGENTS 使用说明](./workflow/同事本地AGENTS使用说明.md)** - 如何给同事单独加 AI 约束,而不污染仓库共享规则
|
||
- **[同事本地 AGENTS 模板](./workflow/同事本地AGENTS模板.md)** - 可直接复制到同事电脑外层工作区的 `AGENTS.md` 模板
|
||
- **[模块边界说明](./workflow/模块边界说明.md)** - 新平台主链、包装协作、旧 CAD 兼容链的边界
|
||
- **[任务单模板](./workflow/任务单模板.md)** - 给人和 Codex 共用的任务模板
|
||
- **[提测与验收清单](./workflow/提测与验收清单.md)** - 提交前必须过的最小检查
|
||
- **[同事交接模板](./workflow/同事交接模板.md)** - 给非程序员同事和 Codex 的交接模板
|
||
|
||
### 🧠 长期记忆与问题收口
|
||
- **[长期记忆导航](./agent-memory/README.md)** - 当前长期记录入口
|
||
- **[长期决策日志](./agent-memory/decision-log.md)** - 近期关键决策
|
||
- **[长期待办与阻塞](./agent-memory/open-issues.md)** - 当前问题收口列表
|
||
|
||
### 📊 阶段完成报告(历史阶段)
|
||
- **[Phase 1: 数据库模型重构](./阶段报告/PHASE1_COMPLETE.md)**
|
||
- **[Phase 2: 认证系统](./阶段报告/PHASE2_COMPLETE.md)**
|
||
- **[Phase 3: 权限系统](./阶段报告/PHASE3_COMPLETE.md)**
|
||
- **[Phase 4: 组织架构](./阶段报告/PHASE4_COMPLETE.md)**
|
||
- **[Phase 5: 产品归属](./阶段报告/PHASE5_COMPLETE.md)**
|
||
- **[Phase 6: 离职交接](./阶段报告/PHASE6_COMPLETE.md)**
|
||
- **[Phase 7: 问题反馈](./阶段报告/PHASE7_COMPLETE.md)**
|
||
- **[Phase 8: 数据安全与日志](./阶段报告/PHASE8_COMPLETE.md)**
|
||
- **[Phase 9: 测试与优化](./阶段报告/Phase9总结.md)**
|
||
- **[Phase 10 完成报告](./Phase10完成报告.md)**
|
||
|
||
### 🧪 测试报告
|
||
- **[安全测试报告](./测试报告/安全测试报告.md)** - SQL 注入、XSS、权限测试
|
||
- **[性能测试报告](./测试报告/性能测试报告.md)** - 前端性能优化结果
|
||
- **[登录测试报告](./测试报告/登录测试报告.md)** - 登录流程测试
|
||
- **[主页测试报告](./测试报告/主页测试报告.md)** - 主页功能测试
|
||
|
||
---
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 1. 查看项目进度
|
||
```bash
|
||
# 查看项目总览
|
||
cat docs/项目总览.md
|
||
```
|
||
|
||
### 2. 了解架构设计
|
||
```bash
|
||
# 查看权限系统设计
|
||
cat docs/架构设计/permission-design-v2.md
|
||
```
|
||
|
||
### 3. 开始开发
|
||
```bash
|
||
# 查看快速开始指南
|
||
cat ../README.md
|
||
```
|
||
|
||
---
|
||
|
||
## 📂 目录结构
|
||
|
||
```
|
||
docs/
|
||
├── README.md # 📖 本文档(导航入口)
|
||
├── 项目总览.md # 🎯 项目整体情况
|
||
├── PHASES_8_9_SUMMARY.md # 📊 最新阶段总结
|
||
├── workflow/ # 🤝 团队协作规则
|
||
│ ├── 团队协作模式.md
|
||
│ ├── 高频协作五条铁律.md
|
||
│ ├── 主线同步操作手册.md
|
||
│ ├── 同事本地AGENTS使用说明.md
|
||
│ ├── 同事本地AGENTS模板.md
|
||
│ ├── 模块边界说明.md
|
||
│ ├── 任务单模板.md
|
||
│ ├── 提测与验收清单.md
|
||
│ ├── 同事交接模板.md
|
||
│ └── 规范审查清单.md
|
||
│
|
||
├── 架构设计/ # 🏗️ 架构相关文档
|
||
│ ├── auth-system-design.md # 认证系统设计
|
||
│ └── permission-design-v2.md # 权限系统设计
|
||
│
|
||
├── 开发指南/ # 📚 开发相关指南
|
||
│ ├── 设计指南.md
|
||
│ ├── 组件使用指南.md
|
||
│ ├── 上传API指南.md
|
||
│ ├── 性能优化指南.md
|
||
│ ├── 数据库优化.md
|
||
│ └── 快速测试指南.md
|
||
│
|
||
├── 阶段报告/ # 📊 各阶段完成文档
|
||
│ ├── PHASE1_COMPLETE.md
|
||
│ ├── PHASE2_COMPLETE.md
|
||
│ ├── ...
|
||
│ ├── PHASE8_COMPLETE.md
|
||
│ ├── Phase9总结.md # ⭐ 当前阶段
|
||
│ ├── 第9阶段_第4天_上午完成.md
|
||
│ ├── 第9阶段_第4天_下午完成.md
|
||
│ ├── 第9阶段_第4天_总结.md
|
||
│ └── 第9阶段_第5天_下午完成.md
|
||
│
|
||
├── 测试报告/ # 🧪 测试相关报告
|
||
│ ├── 安全测试报告.md
|
||
│ ├── 性能测试报告.md
|
||
│ ├── 登录测试报告.md
|
||
│ └── 主页测试报告.md
|
||
│
|
||
└── 历史归档/ # 📦 过时的文档归档
|
||
├── database-redesign-product-sku.md
|
||
├── LOGIN_FLOW_FIXED.md
|
||
├── NEXT_STEPS.md
|
||
├── PHASES_5_6_7_SUMMARY.md
|
||
├── theme-adaptation-fix.md
|
||
├── troubleshooting-theme.md
|
||
├── 迁移指南.md
|
||
├── 用户指南.md
|
||
├── 主题测试指南.md
|
||
└── 实施计划.md
|
||
```
|
||
|
||
---
|
||
|
||
## 🎯 当前状态
|
||
|
||
### 当前重点
|
||
|
||
- 新主线已切到:`资产中心 -> 自动组合 -> 草稿组 -> 包装方案 -> 正式入库 -> 轻仓库`
|
||
- 旧 `CAD 导入 -> SKU 级结构数据 -> 装配编辑 -> 3D 回放` 继续保留为兼容链
|
||
- 当前重点不是继续堆页面,而是先把资产精度、模块边界和团队协作规则立住
|
||
|
||
### 当前建议查看顺序
|
||
|
||
1. **[项目总览](./项目总览.md)**
|
||
2. **[项目上下文](./agent-memory/project-context.md)**
|
||
3. **[长期待办与阻塞](./agent-memory/open-issues.md)**
|
||
4. **[长期决策日志](./agent-memory/decision-log.md)**
|
||
|
||
---
|
||
|
||
## 📞 需要帮助?
|
||
|
||
### 常见问题
|
||
1. **如何查看项目进度?** → 查看 [项目总览](./项目总览.md)
|
||
2. **如何了解权限系统?** → 查看 [权限系统设计](./架构设计/permission-design-v2.md)
|
||
3. **如何了解认证系统?** → 查看 [认证系统设计](./架构设计/auth-system-design.md)
|
||
4. **如何优化性能?** → 查看 [性能优化指南](./开发指南/性能优化指南.md)
|
||
|
||
### 联系方式
|
||
- 查看代码注释
|
||
- 查看相关文档
|
||
- 参考已完成的代码示例
|
||
|
||
---
|
||
|
||
**文档版本**:v2.2
|
||
**最后更新**:2026-03-31
|
||
**维护者**:开发团队
|