107 lines
2.9 KiB
Markdown
107 lines
2.9 KiB
Markdown
|
# Claude 开发规范
|
|||
|
|
|
|||
|
|
> 每次开始开发任务前，请先阅读本文档。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 文档规范
|
|||
|
|
|
|||
|
|
### 开发日志
|
|||
|
|
- **位置**: `/docs/dev-logs/`
|
|||
|
|
- **命名**: `YYYY-MM-DD.md`（如 `2026-02-22.md`）
|
|||
|
|
- **创建时机**: 每天开始开发时，先检查当天日志是否存在，不存在则创建
|
|||
|
|
- **更新时机**: 开发过程中及时记录进展，结束时总结
|
|||
|
|
|
|||
|
|
### 测试记录
|
|||
|
|
- **位置**: `/docs/test-logs/`
|
|||
|
|
- **目录结构**:
|
|||
|
|
- `admin/` - 超管端测试记录
|
|||
|
|
- `school/` - 学校端测试记录
|
|||
|
|
- `teacher/` - 教师端测试记录
|
|||
|
|
- `parent/` - 家长端测试记录
|
|||
|
|
- **命名**: `YYYY-MM-DD.md`
|
|||
|
|
- **创建时机**: 每次进行功能测试时，在对应端目录下创建当天记录
|
|||
|
|
- **更新时机**: 测试过程中实时记录，发现问题及时更新
|
|||
|
|
|
|||
|
|
### 设计文档
|
|||
|
|
- **位置**: `/docs/design/`
|
|||
|
|
- **索引**: `/docs/design/README.md`
|
|||
|
|
|
|||
|
|
### 变更日志
|
|||
|
|
- **位置**: `/docs/CHANGELOG.md`
|
|||
|
|
- **更新时机**: 完成重要功能或修复时更新
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 项目结构
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
ccProgram/
|
|||
|
|
├── docs/ # 📁 项目文档（统一位置）
|
|||
|
|
│ ├── README.md # 项目说明
|
|||
|
|
│ ├── CHANGELOG.md # 变更日志
|
|||
|
|
│ ├── dev-logs/ # 开发日志
|
|||
|
|
│ ├── test-logs/ # 测试记录
|
|||
|
|
│ │ ├── admin/ # 超管端测试
|
|||
|
|
│ │ ├── school/ # 学校端测试
|
|||
|
|
│ │ ├── teacher/ # 教师端测试
|
|||
|
|
│ │ └── parent/ # 家长端测试
|
|||
|
|
│ └── design/ # 设计文档
|
|||
|
|
├── reading-platform-frontend/ # 前端项目
|
|||
|
|
├── reading-platform-backend/ # 后端项目
|
|||
|
|
├── start-all.sh # 统一启动
|
|||
|
|
└── stop-all.sh # 统一停止
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 每日开发流程
|
|||
|
|
|
|||
|
|
1. 读取 `/docs/dev-logs/` 下最新的日志，了解进度
|
|||
|
|
2. 检查当天日志是否存在，不存在则创建
|
|||
|
|
3. 开始开发任务
|
|||
|
|
4. 结束时更新日志和 CHANGELOG
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 功能测试流程
|
|||
|
|
|
|||
|
|
1. 启动前后端服务
|
|||
|
|
2. 在 `/docs/test-logs/{端}/` 下创建当天测试记录
|
|||
|
|
3. 按功能模块逐一测试，记录结果
|
|||
|
|
4. 发现问题立即记录，标明优先级
|
|||
|
|
5. 修复问题后在测试记录中更新状态
|
|||
|
|
6. 测试结束后汇总统计
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 测试账号
|
|||
|
|
|
|||
|
|
| 角色 | 账号 | 密码 |
|
|||
|
|
|------|------|------|
|
|||
|
|
| 超管 | admin | admin123 |
|
|||
|
|
| 学校 | school1 | 123456 |
|
|||
|
|
| 教师 | teacher1 | 123456 |
|
|||
|
|
| 家长 | parent1 | 123456 |
|
|||
|
|
| 家长 | parent2 | 123456 |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 服务启动
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
cd /Users/retirado/ccProgram
|
|||
|
|
./start-all.sh
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## UI 设计规范
|
|||
|
|
|
|||
|
|
**禁止使用 Emoji 图标**: 本项目严禁在前端界面中使用任何 Emoji 表情符号（如 👦 👧 📚 等）。请始终使用 Ant Design Vue 提供的图标组件（如 `@ant-design/icons-vue`）来代替。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
*本规范创建于 2026-02-22*
|
|||
|
|
*最后更新于 2026-02-23*
|