197 lines
7.8 KiB
Markdown
197 lines
7.8 KiB
Markdown
# Ether 智慧物业管理平台 - 项目文档
|
|
|
|
**最后更新**: 2026-03-21
|
|
**适用场景**: 一人团队敏捷开发
|
|
|
|
---
|
|
|
|
## 文档结构
|
|
|
|
```
|
|
docs/
|
|
├── README.md # 本文档（文档索引）
|
|
├── 00-项目总览.md # 项目概览
|
|
├── 01-REQUIREMENTS/ # 需求相关文档
|
|
│ ├── pending-features-spec/ # 待实现功能规格
|
|
│ └── ...
|
|
├── 02-DESIGN/ # 设计相关文档
|
|
│ ├── domains/
|
|
│ │ ├── permission-upgrade-v3/ # 权限升级规格
|
|
│ │ ├── inspection-redesign/ # 巡检重新设计
|
|
│ │ └── batch-operations/ # 批量操作
|
|
│ ├── standards/ # 开发规范
|
|
│ └── ...
|
|
├── 03-PROGRESS/ # 进度跟踪文档
|
|
├── 04-TECHNICAL/ # 技术方案
|
|
│ ├── api-docs.md # API文档
|
|
│ └── ...
|
|
├── 05-ISSUES/ # 问题与解决记录
|
|
├── 06-TESTING/ # 测试相关文档
|
|
│ ├── cases/ # 测试用例
|
|
│ ├── plans/ # 测试计划
|
|
│ ├── reports/ # 测试报告
|
|
│ └── scripts/ # 测试脚本
|
|
├── 07-DEPLOYMENT/ # 部署文档
|
|
├── 08-DATABASE/ # 数据库脚本
|
|
├── assets/ # 资源文件(Excel/脚本)
|
|
├── pending-features.md # 待实现功能列表
|
|
└── 00-项目总览.md
|
|
```
|
|
|
|
---
|
|
|
|
## 文档索引
|
|
|
|
### 01-REQUIREMENTS
|
|
|
|
**用途**: 记录项目需求、功能规格、业务流程
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| -------------------------------------------------------------------------------- | -------------------------- | ---------- |
|
|
| [PRODUCT_REQUIREMENTS.md](01-REQUIREMENTS/PRODUCT_REQUIREMENTS.md) | 产品需求说明书 | 2026-02-10 |
|
|
| [FEATURE_LIST.md](01-REQUIREMENTS/FEATURE_LIST.md) | 功能清单，跟踪功能开发状态 | 2026-02-14 |
|
|
| [DEVELOPMENT_ROADMAP.md](01-REQUIREMENTS/DEVELOPMENT_ROADMAP.md) | 开发路线图与排期 | 2026-02-14 |
|
|
|
|
---
|
|
|
|
### 02-DESIGN
|
|
|
|
**用途**: 技术方案、架构设计、实现规划
|
|
|
|
#### domains/ - 领域技术方案
|
|
|
|
| 目录 | 说明 |
|
|
| ----------------------------------------- | ------------------ |
|
|
| [permission-upgrade-v3/](02-DESIGN/domains/permission-upgrade-v3/) | 权限升级v3规格 |
|
|
| [inspection-redesign/](02-DESIGN/domains/inspection-redesign/) | 巡检重新设计规格 |
|
|
| [batch-operations/](02-DESIGN/domains/batch-operations/) | 批量操作规格 |
|
|
|
|
#### standards/ - 开发规范
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| ------------------------------------------------------------------------ | ------------------------------ | ---------- |
|
|
| [DEVELOPMENT_STANDARDS.md](02-DESIGN/standards/DEVELOPMENT_STANDARDS.md) | 代码规范、数据库规范、接口规范 | 2026-02-10 |
|
|
| [FRONTEND_STANDARDS.md](02-DESIGN/standards/FRONTEND_STANDARDS.md) | 前端代码规范 | 2026-02-10 |
|
|
|
|
#### 整体方案
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| ------------------------------------------------------------------------ | ---------------- | ---------- |
|
|
| [IMPLEMENTATION_PLAN.md](02-DESIGN/IMPLEMENTATION_PLAN.md) | 项目整体实施方案 | 2026-02-08 |
|
|
|
|
---
|
|
|
|
### 03-PROGRESS
|
|
|
|
**用途**: 跟踪项目进度、记录完成情况
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| ------------------------------------------------------ | ------------ | ---------- |
|
|
| [PROJECT_PROGRESS.md](03-PROGRESS/PROJECT_PROGRESS.md) | 项目进度总览 | 2026-02-14 |
|
|
|
|
---
|
|
|
|
### 04-TECHNICAL
|
|
|
|
**用途**: 技术方案与最佳实践
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| ------------------------------------------------- | ------------ | ---------- |
|
|
| [api-docs.md](04-TECHNICAL/api-docs.md) | API接口文档 | - |
|
|
| [ROUTING_BEST_PRACTICES.md](04-TECHNICAL/ROUTING_BEST_PRACTICES.md) | 路由最佳实践 | 2026-02-10 |
|
|
|
|
---
|
|
|
|
### 05-ISSUES
|
|
|
|
**用途**: 记录开发过程中遇到的问题及解决方案
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| ------------------------------------------------------------ | ------------ | ---------- |
|
|
| [ISSUE_RESOLUTION_LOG.md](05-ISSUES/ISSUE_RESOLUTION_LOG.md) | 问题解决记录 | 2026-02-10 |
|
|
|
|
---
|
|
|
|
### 06-TESTING
|
|
|
|
**用途**: 测试计划、测试用例、测试报告
|
|
|
|
| 子目录 | 说明 |
|
|
| ------------------------------- | ---------------------- |
|
|
| [cases/](06-TESTING/cases/) | 功能测试用例 |
|
|
| [plans/](06-TESTING/plans/) | 测试计划文档 |
|
|
| [reports/](06-TESTING/reports/) | 测试执行报告 |
|
|
| [scripts/](06-TESTING/scripts/) | 自动化测试脚本 |
|
|
|
|
---
|
|
|
|
### 07-DEPLOYMENT
|
|
|
|
**用途**: 部署相关文档
|
|
|
|
| 文档 | 说明 | 更新时间 |
|
|
| ------------------------------------------ | -------- | ---------- |
|
|
| [DEPLOYMENT.md](07-DEPLOYMENT/DEPLOYMENT.md) | 部署文档 | - |
|
|
|
|
---
|
|
|
|
### 08-DATABASE
|
|
|
|
**用途**: 数据库初始化与测试数据
|
|
|
|
| 文件 | 说明 |
|
|
| ---------------------------------------------------------- | ------------------- |
|
|
| [test-data-mdm.sql](08-DATABASE/test-data-mdm.sql) | MDM模块测试数据 |
|
|
| [test-data-ops.sql](08-DATABASE/test-data-ops.sql) | OPS模块测试数据 |
|
|
| [test-data-finance.sql](08-DATABASE/test-data-finance.sql) | Finance模块测试数据 |
|
|
| [test-data-owner.sql](08-DATABASE/test-data-owner.sql) | Owner模块测试数据 |
|
|
| [test-users.sql](08-DATABASE/test-users.sql) | 测试用户数据 |
|
|
|
|
---
|
|
|
|
### assets/ - 资源文件
|
|
|
|
**用途**: 存放Excel、脚本等非文档资源
|
|
|
|
| 文件 | 说明 |
|
|
| --------------------------------------------------------- | ------------ |
|
|
| [功能清单.xlsx](assets/功能清单.xlsx) | 功能清单表 |
|
|
| [上海菲西尔智能科技有限公司 - 报价单.xlsx](assets/上海菲西尔智能科技有限公司 - 报价单.xlsx) | 报价单 |
|
|
| [generate_function_list.py](assets/generate_function_list.py) | 功能列表生成脚本 |
|
|
|
|
---
|
|
|
|
## 使用指南
|
|
|
|
### 日常开发工作流
|
|
|
|
1. **开始新功能前**
|
|
- 查看 `03-PROGRESS/PROJECT_PROGRESS.md` 确认当前阶段
|
|
- 查看 `01-REQUIREMENTS/` 确认需求范围
|
|
|
|
2. **开发过程中**
|
|
- 遇到新问题记录在 `05-ISSUES/ISSUE_RESOLUTION_LOG.md`
|
|
- 参考 `02-DESIGN/` 中的技术方案
|
|
|
|
3. **完成功能后**
|
|
- 更新 `03-PROGRESS/PROJECT_PROGRESS.md` 标记完成
|
|
- 更新 `01-REQUIREMENTS/FEATURE_LIST.md` 功能状态
|
|
|
|
4. **测试阶段**
|
|
- 编写测试用例到 `06-TESTING/cases/`
|
|
- 执行测试后报告存入 `06-TESTING/reports/`
|
|
|
|
---
|
|
|
|
## 快速链接
|
|
|
|
- 📋 [项目进度](03-PROGRESS/PROJECT_PROGRESS.md)
|
|
- 📝 [功能清单](01-REQUIREMENTS/FEATURE_LIST.md)
|
|
- 🗺️ [开发路线图](01-REQUIREMENTS/DEVELOPMENT_ROADMAP.md)
|
|
- 🐛 [问题记录](05-ISSUES/ISSUE_RESOLUTION_LOG.md)
|
|
- 📐 [实施方案](02-DESIGN/IMPLEMENTATION_PLAN.md)
|
|
|
|
---
|
|
|
|
**维护说明**: 本文档由项目负责人维护，保持简洁实用，避免过度文档化。
|