Files
diary-system/docs/README.md

71 lines
1.5 KiB
Markdown

# 日记系统 - 模块文档索引
_每个模块都有独立的需求说明,修改前先阅读对应文档_
---
## 📁 文档结构
```
docs/
├── README.md # 本文档(索引)
├── CALENDAR.md # 日历组件 ⭐ 核心功能
├── DIARY.md # 日记模块 ⭐ 核心功能
├── EXPERIENCE.md # 经验总结模块
├── STATS.md # 统计面板
└── TASKS.md # 任务管理(待创建)
```
---
## 🔧 修改代码时的流程
### 1. 确定修改的模块
| 修改内容 | 阅读文档 | 测试命令 |
|---------|---------|---------|
| 日历样式 | `CALENDAR.md` | `test_frontend.py diary` |
| 日记字段 | `DIARY.md` | `test_frontend.py diary` |
| 经验总结 | `EXPERIENCE.md` | `test_frontend.py experience` |
| 统计面板 | `STATS.md` | `test_frontend.py` |
### 2. 阅读文档
- 查看功能列表
- 确认**不能删除**的部分
- 了解修改指南
### 3. 增量修改
- 只添加,不覆盖
- 只修改相关模块
- 保持其他功能不变
### 4. 针对性测试
```bash
python3 test_frontend.py <模块名>
```
---
## ⚠️ 核心功能(除非用户明确要求,否则不动)
1. **日历组件** (`CALENDAR.md`)
- 月历视图
- 点击日期显示日记
- 上月/下月切换
2. **日记模块** (`DIARY.md`)
- 日记 CRUD
- 日历集成
3. **Tab 切换**
- 工作任务
- 日记
- 经验总结
---
_修改任何代码前,先阅读对应模块文档_