7.6 KiB
7.6 KiB
家具开品平台 - 文档导航
最后更新：2026-03-31
项目状态：新平台一期骨架已落地，旧CAD -> 装配步骤链继续作为兼容链保留
📖 快速导航
🎯 了解项目进度
🏗️ 架构设计
📚 开发指南
- 设计系统 - Apple 风格 UI 组件使用
- 组件使用指南 - 常用组件的使用方法
- 上传 API 指南 - 文件上传功能使用
- 性能优化指南 - 性能优化最佳实践
- 数据库优化 - 数据库查询优化
- 快速测试指南 - 测试相关指南
- 项目上下文 - 当前高频回归点、默认工作流、项目目标
🤝 团队协作
- 团队协作模式 - 当前推荐分工、分支规则、提交流程
- 高频协作五条铁律 - 双 Codex 高频协作时的 5 条固定规则
- 主线同步操作手册 - 主线持续更新时，同事如何安全同步自己的分支
- 同事本地 AGENTS 使用说明 - 如何给同事单独加 AI 约束，而不污染仓库共享规则
- 同事本地 AGENTS 模板 - 可直接复制到同事电脑外层工作区的
AGENTS.md模板 - 模块边界说明 - 新平台主链、包装协作、旧 CAD 兼容链的边界
- 任务单模板 - 给人和 Codex 共用的任务模板
- 提测与验收清单 - 提交前必须过的最小检查
- 同事交接模板 - 给非程序员同事和 Codex 的交接模板
🧠 长期记忆与问题收口
📊 阶段完成报告（历史阶段）
- Phase 1: 数据库模型重构
- Phase 2: 认证系统
- Phase 3: 权限系统
- Phase 4: 组织架构
- Phase 5: 产品归属
- Phase 6: 离职交接
- Phase 7: 问题反馈
- Phase 8: 数据安全与日志
- Phase 9: 测试与优化
- Phase 10 完成报告
🧪 测试报告
🚀 快速开始
1. 查看项目进度
# 查看项目总览
cat docs/项目总览.md
2. 了解架构设计
# 查看权限系统设计
cat docs/架构设计/permission-design-v2.md
3. 开始开发
# 查看快速开始指南
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 回放继续保留为兼容链 - 当前重点不是继续堆页面，而是先把资产精度、模块边界和团队协作规则立住
当前建议查看顺序
📞 需要帮助？
常见问题
联系方式
- 查看代码注释
- 查看相关文档
- 参考已完成的代码示例
文档版本：v2.2
最后更新：2026-03-31
维护者：开发团队