更新使用文档

This commit is contained in:
2026-04-21 14:21:33 +08:00
parent 99b892797b
commit 8f89505157
9 changed files with 346 additions and 127 deletions

View File

@@ -184,9 +184,15 @@ classmanager/
│ └── init.sql # 初始化表结构 │ └── init.sql # 初始化表结构
├── docs/ # 文档 ├── docs/ # 文档
│ ├── 学生端使用教程.md │ ├── student.md # 学生端详细文档
│ ├── 家长端使用教程.md │ ├── parent.md # 家长端详细文档
── 管理端使用教程.md ── teacher.md # 班主任详细文档
│ ├── cadre.md # 班干部详细文档
│ └── guide/ # 快速使用说明
│ ├── student.md
│ ├── parent.md
│ ├── teacher.md
│ └── cadre.md
├── .gitignore ├── .gitignore
├── INSTALL.md # 安装部署文档 ├── INSTALL.md # 安装部署文档
@@ -220,9 +226,16 @@ classmanager/
## 使用说明 ## 使用说明
- 学生端详见 [student.md](docs/student.md) 详细文档:
- 家长端详见 [parent.md](docs/parent.md)
- 管理端详见 [admin.md](docs/admin.md) - 学生端详见 [docs/student.md](docs/student.md)
- 家长端详见 [docs/parent.md](docs/parent.md)
- 班主任详见 [docs/teacher.md](docs/teacher.md)
- 班干部详见 [docs/cadre.md](docs/cadre.md)
快速使用指南:
- [学生端](docs/guide/student.md) / [家长端](docs/guide/parent.md) / [班主任](docs/guide/teacher.md) / [班干部](docs/guide/cadre.md)
## 版本 ## 版本

158
docs/cadre.md Normal file
View File

@@ -0,0 +1,158 @@
# 班干部使用文档
## 登录
1. 打开系统网址,进入登录页面
2. 输入**用户名**和**密码**
3. 点击"登录"按钮
4. 首次登录系统会强制要求修改密码
> **密码要求**长度6-20位必须包含大写字母、小写字母、数字、特殊符号中的至少3种。
---
## 角色权限一览
| 角色 | 操行分管理 | 历史记录 | 作业管理 | 考勤管理 | 科目管理 |
|------|-----------|---------|---------|---------|---------|
| 班长 | ±5分以内 | 全部(可撤销) | - | - | - |
| 学习委员 | - | 自己的 | ✓ | - | ✓ |
| 考勤委员 | - | 自己的 | - | ✓ | - |
| 劳动委员 | ±1分卫生值日 | 自己的 | - | - | - |
| 志愿委员 | 仅加分 | 自己的 | - | - | - |
---
## 功能说明
### 班长
#### 操行分管理 (conduct.php)
**加减分操作**
1. 在学生列表中勾选目标学生
2. 点击"批量加减分"按钮
3. 填写分数变动±5分以内和原因
4. 点击"确认提交"
**加减分限制**每次操作不超过±5分。
#### 历史记录 (history.php)
- 可查看全班所有操行分变动记录
- 可按时间范围和学生筛选
- **可撤销**任何人的扣分记录
---
### 学习委员
#### 作业管理 (homework.php)
本模块用于管理学生作业缺交情况。
**批量扣分**
1. 在学生列表中勾选目标学生
2. 点击"批量加减分"按钮
3. 选择扣分类型:
- **未交作业**按配置扣分默认2分
- **迟交作业**按配置扣分默认1分
- **自定义**:手动输入扣分值
4. 填写原因(自动填充或手动修改)
5. 可选择是否关联扣分
6. 点击"确认提交"
> 扣分限制每次加减分不超过3分。
#### 科目管理 (subjects.php)
- 查看科目列表
- 添加/编辑/删除/启用/禁用科目
#### 历史记录
- 仅可查看自己提交的操作记录
---
### 考勤委员
#### 考勤管理 (attendance.php)
**添加考勤记录**
1. 点击"添加考勤"按钮
2. 选择学生(支持多选)
3. 选择日期
4. 选择考勤状态:正常 / 迟到 / 缺勤 / 请假
5. 填写备注(可选)
6. 设置是否关联扣分(默认开启)
7. 点击"确认提交"
**默认扣分规则**
| 考勤状态 | 默认扣分 |
|---------|---------|
| 缺勤 | 5分 |
| 迟到 | 2分 |
| 请假 | 1分 |
#### 历史记录
- 仅可查看自己提交的操作记录
---
### 劳动委员
#### 操行分管理 (conduct.php)
**加减分操作**
1. 在学生列表中勾选目标学生
2. 点击"批量加减分"按钮
3. 以卫生值日为由进行 ±1 分操作
4. 点击"确认提交"
> 限制:固定 ±1 分。
#### 历史记录
- 仅可查看自己提交的操作记录
---
### 志愿委员
#### 操行分管理 (conduct.php)
**加分操作**
1. 在学生列表中勾选目标学生
2. 点击"批量加减分"按钮
3. 以服务时长为由进行加分
4. 点击"确认提交"
> 限制:仅限加分操作。
#### 历史记录
- 仅可查看自己提交的操作记录
---
## 修改密码 (password.php)
- 输入原密码和新密码
- 新密码需符合密码强度要求
- 修改成功后需重新登录
---
## 常见问题
### Q: 忘记密码怎么办?
请联系班主任重置密码。
### Q: 为什么只能看到自己的记录?
班干部角色默认仅查看自己提交的操作记录(班长可查看全部)。
### Q: 考勤扣分规则可以修改吗?
考勤扣分规则在系统配置中设置,如需调整请联系班主任。

42
docs/guide/cadre.md Normal file
View File

@@ -0,0 +1,42 @@
# 班干部使用说明
## 登录
输入**用户名**和**密码**登录。首次登录需强制修改密码。
> 密码要求6-20位包含大写字母、小写字母、数字、特殊符号中的至少3种。
## 角色权限
| 角色 | 操行分管理 | 历史记录 | 作业管理 | 考勤管理 | 科目管理 |
|------|-----------|---------|---------|---------|---------|
| 班长 | ±5分以内 | 全部(可撤销) | - | - | - |
| 学习委员 | - | 自己的 | ✓ | - | ✓ |
| 考勤委员 | - | 自己的 | - | ✓ | - |
| 劳动委员 | ±1分卫生值日 | 自己的 | - | - | - |
| 志愿委员 | 仅加分 | 自己的 | - | - | - |
## 常用操作
### 班长
- **加减分**:勾选学生 → 批量加减分 → 填写分值±5分以内和原因
- **撤销记录**:历史记录页 → 点击撤销按钮
### 学习委员
- **作业扣分**:勾选学生 → 批量加减分 → 选择未交/迟交/自定义 → 填写原因
- **科目管理**:添加/编辑/删除科目
### 考勤委员
- **添加考勤**:选择学生 → 选择日期和状态 → 填写备注 → 确认提交
- 默认扣分缺勤5分、迟到2分、请假1分
### 劳动委员
- **加减分**:以卫生值日为由进行 ±1 分操作
### 志愿委员
- **加分**:以服务时长为由进行加分操作
## 常见问题
- **忘记密码**:联系班主任重置。
- **只能看到自己的记录**:班干部角色默认仅查看自己提交的操作记录(班长可查看全部)。

18
docs/guide/parent.md Normal file
View File

@@ -0,0 +1,18 @@
# 家长端使用说明
## 登录
输入**手机号**和**密码**登录。账号由系统自动创建,与子女信息关联。
## 功能概览
| 页面 | 说明 |
|------|------|
| 首页 | 查看子女操行分、班级排名、初始分提示 |
| 历史记录 | 查看子女加减分明细(时间、类型、原因、分值、记录人),支持分页 |
| 考勤记录 | 查看子女考勤记录(出勤/缺勤/迟到/请假统计 + 明细列表) |
## 常见问题
- **忘记密码**:联系班主任重置。
- **初始操行分**默认60分首页底部有提示。

22
docs/guide/student.md Normal file
View File

@@ -0,0 +1,22 @@
# 学生端使用说明
## 登录
输入**长学号**和**密码**登录。首次登录需强制修改密码。
> 密码要求6-20位包含大写字母、小写字母、数字、特殊符号中的至少3种。
## 功能概览
| 页面 | 说明 |
|------|------|
| 首页 | 查看操行分、班级排名、作业完成率、出勤率 |
| 操行分详情 | 查看完整加减分历史(时间、分值、原因、操作人) |
| 作业情况 | 查看缺交作业记录(科目、状态、备注) |
| 考勤记录 | 查看个人考勤记录(按月) |
| 修改密码 | 修改登录密码 |
## 常见问题
- **忘记密码**:联系班主任或开发人员重置。
- **操行分有误**:联系班主任或班长核实调整。

38
docs/guide/teacher.md Normal file
View File

@@ -0,0 +1,38 @@
# 班主任使用说明
## 登录
输入**用户名**和**密码**登录。首次登录需强制修改密码。
> 密码要求6-20位包含大写字母、小写字母、数字、特殊符号中的至少3种。
## 功能概览
班主任拥有管理端全部权限:
| 页面 | 功能 |
|------|------|
| 首页 | 查看学生总数、排行榜、快捷入口 |
| 操行分管理 | 对学生加减分(无限制)、导出德育分记录 |
| 历史记录 | 查看/导出/撤销全班记录 |
| 作业管理 | 发布缺交作业记录、关联扣分 |
| 考勤管理 | 添加考勤记录、自定义扣分值 |
| 学生管理 | 新增/编辑/删除/批量导入学生 |
| 科目管理 | 增删改科目 |
| 管理员管理 | 添加/编辑/删除/重置密码班干部账号 |
| 修改密码 | 修改登录密码 |
## 常用操作
- **加减分**:勾选学生 → 批量加减分 → 填写分值和原因
- **导出德育分**:操行分管理页 → 导出德育分记录CSV
- **导出历史记录**:历史记录页 → 导出历史记录CSV可按日期/学生筛选)
- **撤销记录**:历史记录页 → 点击撤销按钮
- **导入学生**:学生管理页 → 导入学生JSON格式需包含 `student_no``name`
- **添加班干部**:管理员管理页 → 添加管理员 → 填写账号信息和角色
- **重置班干部密码**:管理员管理页 → 重置密码 → 输入新密码
## 常见问题
- **班主任忘记密码**:联系系统管理员通过调试接口重置。
- **考勤扣分规则**:在系统配置中设置,添加考勤时也可自定义扣分值。

View File

@@ -3,9 +3,8 @@
## 登录 ## 登录
1. 打开系统网址,进入登录页面 1. 打开系统网址,进入登录页面
2. 选择"家长"身份 2. 输入**手机号**和**初始密码**
3. 输入在学校请假系统使用的的**手机号**和**初始密码** 3. 点击"登录"按钮
4. 点击"登录"按钮
> **注意**:家长账号由班主任创建,与子女信息关联。每个学生对应一个家长账号。 > **注意**:家长账号由班主任创建,与子女信息关联。每个学生对应一个家长账号。
@@ -13,8 +12,6 @@
## 功能说明 ## 功能说明
家长端包含以下页面:
### 1. 首页 ### 1. 首页
登录后进入家长端首页,展示以下信息: 登录后进入家长端首页,展示以下信息:
@@ -56,13 +53,11 @@
## 导航栏说明 ## 导航栏说明
家长端导航栏包含以下入口: | 导航项 | 说明 |
|-------|------|
| 导航项 | 页面 | 说明 | | 首页 | 子女信息、操行分和排名概览 |
|-------|------|------| | 历史记录 | 子女操行分变动历史明细 |
| 首页 | /parent/dashboard.php | 子女信息、操行分和排名概览 | | 考勤记录 | 子女考勤记录明细 |
| 历史记录 | /parent/history.php | 子女操行分变动历史明细 |
| 考勤记录 | /parent/attendance.php | 子女考勤记录明细 |
--- ---

View File

@@ -3,7 +3,7 @@
## 登录 ## 登录
1. 打开系统网址,进入登录页面 1. 打开系统网址,进入登录页面
2. 输入**长学号**和**密码** 2. 输入**长学号**和**密码**
3. 点击"登录"按钮 3. 点击"登录"按钮
4. 首次登录系统会强制要求修改密码,请设置一个安全的新密码 4. 首次登录系统会强制要求修改密码,请设置一个安全的新密码
@@ -13,8 +13,6 @@
## 功能说明 ## 功能说明
学生端包含以下页面:
### 1. 首页 ### 1. 首页
登录后进入学生端首页,展示以下信息: 登录后进入学生端首页,展示以下信息:
@@ -68,6 +66,18 @@
--- ---
## 导航栏说明
| 导航项 | 说明 |
|-------|------|
| 首页 | 概览信息和快捷数据 |
| 操行分详情 | 完整加减分历史 |
| 作业情况 | 作业缺交记录 |
| 考勤记录 | 考勤记录明细 |
| 修改密码 | 修改登录密码 |
---
## 常见问题 ## 常见问题
### Q: 忘记密码怎么办? ### Q: 忘记密码怎么办?
@@ -75,17 +85,3 @@
### Q: 操行分有误怎么办? ### Q: 操行分有误怎么办?
请联系班主任或班长核实并调整。 请联系班主任或班长核实并调整。
---
## 导航栏说明
学生端底部/顶部导航栏包含以下入口:
| 导航项 | 页面 | 说明 |
|-------|------|------|
| 首页 | /student/dashboard.php | 概览信息和快捷数据 |
| 操行分详情 | /student/conduct_history.php | 完整加减分历史 |
| 作业情况 | /student/homework.php | 作业缺交记录 |
| 考勤记录 | /student/attendance.php | 考勤记录明细 |
| 修改密码 | /student/password.php | 修改登录密码 |

View File

@@ -1,4 +1,4 @@
# 管理端使用文档 # 班主任使用文档
## 登录 ## 登录
@@ -11,32 +11,19 @@
--- ---
## 角色说明
管理端根据角色不同,拥有不同的功能权限:
| 角色 | 操行分管理 | 历史记录 | 作业管理 | 考勤管理 | 科目管理 | 管理员管理 | 数据导出 |
|------|-----------|---------|---------|---------|---------|-----------|---------|
| 班主任 | 无限制 | 全部 | 全部 | 全部 | ✓ | ✓ | ✓ |
| 班长 | ±5分 | 全部 | - | - | - | - | - |
| 学习委员 | - | 自己的 | ✓ | - | ✓ | - | - |
| 考勤委员 | - | 自己的 | - | ✓ | - | - | - |
| 劳动委员 | ±1分 | 自己的 | - | - | - | - | - |
| 志愿委员 | 仅加分 | 自己的 | - | - | - | - | - |
---
## 功能说明 ## 功能说明
班主任拥有管理端**全部权限**。
### 1. 首页 (dashboard.php) ### 1. 首页 (dashboard.php)
管理端首页展示以下内容: 管理端首页展示以下内容:
- **统计数据**:学生总数 - **统计数据**:学生总数
- **快捷操作** - **快捷操作**
- 操行分管理(班主任/班长/劳动委员/志愿委员) - 操行分管理
- 导入学生(班主任) - 导入学生
- 导出德育分记录(班主任) - 导出德育分记录
- **操行分排行榜**展示前100名学生的排名、学号、姓名和操行分 - **操行分排行榜**展示前100名学生的排名、学号、姓名和操行分
--- ---
@@ -55,18 +42,9 @@
- **原因**:填写加减分原因(必填) - **原因**:填写加减分原因(必填)
4. 点击"确认提交" 4. 点击"确认提交"
**加减分限制** > 班主任加减分限制
| 角色 | 限制 |
|------|------|
| 班主任 | 无限制 |
| 班长 | ±5分以内 |
| 劳动委员 | 固定±1分卫生值日理由 |
| 志愿委员 | 仅限加分 |
#### 单人加减分 #### 导出德育分记录
点击学生行右侧的"加减分"按钮,操作同批量加减分。
#### 导出德育分记录(仅班主任)
1. 点击"导出德育分记录"按钮 1. 点击"导出德育分记录"按钮
2. 系统自动生成CSV文件并下载 2. 系统自动生成CSV文件并下载
3. 文件格式:`学号,姓名,分数,加分历史,减分记录` 3. 文件格式:`学号,姓名,分数,加分历史,减分记录`
@@ -83,22 +61,22 @@
- **学生**:按学生筛选 - **学生**:按学生筛选
- 点击"查询"按钮刷新列表 - 点击"查询"按钮刷新列表
#### 导出历史记录(仅班主任) #### 导出历史记录
1. 设置筛选条件(可选) 1. 设置筛选条件(可选)
2. 点击"导出历史记录"按钮 2. 点击"导出历史记录"按钮
3. 系统自动生成CSV文件并下载 3. 系统自动生成CSV文件并下载
4. 文件格式:`时间,学号,姓名,分数变动,原因,操作人` 4. 文件格式:`时间,学号,姓名,分数变动,原因,操作人`
#### 撤销记录(班主任/班长) #### 撤销记录
1. 在历史记录列表中找到目标记录 1. 在历史记录列表中找到目标记录
2. 点击右侧"撤销"按钮 2. 点击右侧"撤销"按钮
3. 确认撤销操作 3. 确认撤销操作
--- ---
### 4. 作业管理 (homework.php)(班主任/学习委员) ### 4. 作业管理 (homework.php)
本模块用于管理学生作业缺交情况,学习委员可发布缺交作业记录并关联扣分 本模块用于管理学生作业缺交情况。
#### 查看学生列表 #### 查看学生列表
- 展示所有学生的学号、姓名、当前操行分 - 展示所有学生的学号、姓名、当前操行分
@@ -115,42 +93,28 @@
5. 可选择是否关联扣分 5. 可选择是否关联扣分
6. 点击"确认提交" 6. 点击"确认提交"
**扣分限制**每次加减分不超过3分 > 扣分限制每次加减分不超过3分
#### 学生端作业查看
学生可在学生端"作业情况"页面查看:
- 科目、作业标题
- 截止日期
- 提交状态
- 教师备注
--- ---
### 5. 考勤管理 (attendance.php)(班主任/考勤委员) ### 5. 考勤管理 (attendance.php)
#### 添加考勤记录 #### 添加考勤记录
1. 点击"添加考勤"按钮 1. 点击"添加考勤"按钮
2. 选择学生(支持多选) 2. 选择学生(支持多选)
3. 选择日期 3. 选择日期
4. 选择考勤状态: 4. 选择考勤状态:正常 / 迟到 / 缺勤 / 请假
- 正常
- 迟到
- 缺勤
- 请假
5. 填写备注(可选) 5. 填写备注(可选)
6. 设置是否关联扣分(默认开启) 6. 设置是否关联扣分(默认开启)
7. 可自定义扣分值(仅班主任) 7. 可自定义扣分值
8. 点击"确认提交" 8. 点击"确认提交"
#### 查看考勤记录 #### 查看考勤记录
- 按日期和学生筛选考勤记录 - 按日期和学生筛选考勤记录
- 每条记录显示: - 每条记录显示:学号、姓名、日期、考勤状态、备注
- 学号、姓名
- 日期
- 考勤状态
- 备注
**默认扣分规则** **默认扣分规则**
| 考勤状态 | 默认扣分 | | 考勤状态 | 默认扣分 |
|---------|---------| |---------|---------|
| 缺勤 | 5分 | | 缺勤 | 5分 |
@@ -159,7 +123,7 @@
--- ---
### 6. 学生管理 (students.php)(仅班主任) ### 6. 学生管理 (students.php)
#### 查看学生列表 #### 查看学生列表
- 展示所有学生的学号、姓名、家长手机号、状态等信息 - 展示所有学生的学号、姓名、家长手机号、状态等信息
@@ -182,7 +146,7 @@
--- ---
### 7. 科目管理 (subjects.php)(班主任/学习委员) ### 7. 科目管理 (subjects.php)
#### 查看科目列表 #### 查看科目列表
- 展示所有科目及其状态 - 展示所有科目及其状态
@@ -200,10 +164,7 @@
--- ---
### 8. 管理员管理 (admins.php)(仅班主任) ### 8. 管理员管理 (admins.php)
#### 查看管理员列表
- 展示所有管理员的用户名、姓名、角色
#### 添加管理员 #### 添加管理员
1. 点击"添加管理员"按钮 1. 点击"添加管理员"按钮
@@ -216,19 +177,15 @@
4. 添加成功后会显示管理员信息和初始密码(请妥善保存) 4. 添加成功后会显示管理员信息和初始密码(请妥善保存)
#### 编辑管理员 #### 编辑管理员
1. 点击管理员行的"编辑"按钮 - 点击"编辑"按钮修改角色类型
2. 修改角色类型
3. 点击"保存"
#### 重置密码 #### 重置密码
1. 点击管理员行的"重置密码"按钮 1. 点击"重置密码"按钮
2. 输入新密码至少6位 2. 输入新密码
3. 点击"确认重置" 3. 点击"确认重置"
#### 删除管理员 #### 删除管理员
1. 点击管理员行的"删除"按钮 - 点击"删除"按钮确认删除(不可恢复)
2. 确认删除操作
3. 不可恢复,请谨慎操作
--- ---
@@ -240,40 +197,22 @@
--- ---
## 导航栏说明
管理端侧边导航栏包含以下入口:
| 导航项 | 页面 | 权限 |
|-------|------|------|
| 首页 | /admin/dashboard.php | 所有管理员 |
| 操行分管理 | /admin/conduct.php | 班主任/班长/劳动委员/志愿委员 |
| 历史记录 | /admin/history.php | 所有管理员 |
| 作业管理 | /admin/homework.php | 班主任/学习委员 |
| 考勤管理 | /admin/attendance.php | 班主任/考勤委员 |
| 学生管理 | /admin/students.php | 班主任 |
| 科目管理 | /admin/subjects.php | 班主任/学习委员 |
| 管理员管理 | /admin/admins.php | 班主任 |
| 修改密码 | /admin/password.php | 所有管理员 |
---
## 常见问题 ## 常见问题
### Q: 忘记密码怎么办? ### Q: 忘记密码怎么办?
班主任密码请联系系统管理员通过调试接口重置。其他管理员请联系班主任或开发人员重置。 请联系系统管理员通过调试接口重置。
### Q: 如何导出全班德育分记录? ### Q: 如何导出全班德育分记录?
班主任登录后,在"操行分管理"页面点击"导出德育分记录"按钮系统会生成包含所有学生当前分数及加减分历史的CSV文件。 在"操行分管理"页面点击"导出德育分记录"按钮系统会生成包含所有学生当前分数及加减分历史的CSV文件。
### Q: 如何撤销错误的加减分? ### Q: 如何撤销错误的加减分?
在"历史记录"页面找到对应记录,点击"撤销"按钮。班主任和班长可以撤销任何人的扣分记录。 在"历史记录"页面找到对应记录,点击"撤销"按钮。
### Q: 导入学生时格式错误怎么办? ### Q: 导入学生时格式错误怎么办?
请确保上传的文件是JSON格式包含 `students` 数组,每个学生对象至少包含 `student_no`(学号)和 `name`(姓名)字段。 请确保上传的文件是JSON格式包含 `students` 数组,每个学生对象至少包含 `student_no`(学号)和 `name`(姓名)字段。
### Q: 考勤扣分规则可以修改吗? ### Q: 考勤扣分规则可以修改吗?
考勤扣分规则在系统配置中设置,如需调整请联系系统管理员修改后端配置文件。班主任在添加考勤记录时可以自定义扣分值。 考勤扣分规则在系统配置中设置。班主任在添加考勤记录时可以自定义扣分值。
--- ---
@@ -281,14 +220,12 @@
### 德育分记录导出 ### 德育分记录导出
- **位置**:操行分管理页面 - **位置**:操行分管理页面
- **权限**:仅班主任
- **格式**CSVUTF-8编码 - **格式**CSVUTF-8编码
- **字段**:学号、姓名、分数、加分历史、减分记录 - **字段**:学号、姓名、分数、加分历史、减分记录
- **文件名**`德育分记录_日期.csv` - **文件名**`德育分记录_日期.csv`
### 历史记录导出 ### 历史记录导出
- **位置**:历史记录页面 - **位置**:历史记录页面
- **权限**:仅班主任
- **格式**CSVUTF-8编码 - **格式**CSVUTF-8编码
- **字段**:时间、学号、姓名、分数变动、原因、操作人 - **字段**:时间、学号、姓名、分数变动、原因、操作人
- **支持筛选**:可按时间范围和学生筛选后导出 - **支持筛选**:可按时间范围和学生筛选后导出