ae33bd4d6a
- 项目文档：PRD、SRS、架构设计文档、前后端详细设计文档、架构设计规范 - 数据库脚本：用户创建和数据库初始化脚本 - 后端框架：Spring Boot 3.2 + MyBatis-Plus 3.5 基础架构 - 公共组件：统一返回结果、分页封装、全局异常处理 - 基础功能：链路追踪、API日志、健康检查接口 - 配置文件：application.yml.example 配置模板 - 开发规范：遵循架构设计规范，data目录存放MyBatis-Plus文件
157 lines
8.6 KiB
Markdown
157 lines
8.6 KiB
Markdown
# 工作日志服务平台产品规格说明书 (PRD)
|
||
**版本号：** V1.0
|
||
**拟定日期：** 2024 年 5 月
|
||
**适用年度：** 2026 年人员管理规划
|
||
**文档状态：** 草稿
|
||
|
||
---
|
||
|
||
## 1. 项目概述
|
||
|
||
### 1.1 项目背景
|
||
为配合 2026 年公司人员管理数字化升级需求，计划构建一套轻量级、多终端的工作日志服务平台。旨在规范员工日常工作记录，沉淀工作成果，并通过模板化管理提高日志填写的效率与质量。
|
||
|
||
### 1.2 项目目标
|
||
1. **规范化：** 统一人员信息管理与日志格式。
|
||
2. **便捷化：** 支持 PC 管理后台与移动端随时记录。
|
||
3. **轻量化：** 聚焦核心功能，确保系统响应速度快，维护成本低。
|
||
4. **安全性：** 保障人员信息与工作数据的安全，符合 2026 年数据安全合规要求。
|
||
|
||
### 1.3 适用范围
|
||
* **管理后台（Web 端）：** 供 HR、系统管理员及部门管理者使用。
|
||
* **移动端（H5/小程序/App）：** 供全体员工日常填写与查看日志使用。
|
||
|
||
---
|
||
|
||
## 2. 用户角色与权限
|
||
|
||
| 角色 | 描述 | 核心权限 |
|
||
| :--- | :--- | :--- |
|
||
| **系统管理员** | 负责系统基础配置与人员管理 | 人员管理（全权）、模板管理（全权）、查看所有日志、启用/禁用功能 |
|
||
| **普通员工** | 系统的主要使用者 | 填写/编辑/删除**本人**日志、查看可用模板、修改本人基本信息 |
|
||
|
||
*(注：本期 V1.0 主要区分“管理员”与“普通用户”，管理者权限可后续通过数据范围控制实现)*
|
||
|
||
---
|
||
|
||
## 3. 功能需求详情
|
||
|
||
### 3.1 人员信息管理模块
|
||
**目标：** 维护系统使用者的基础档案与账号状态。
|
||
|
||
| 功能点 | 详细描述 | 字段/规则 |
|
||
| :--- | :--- | :--- |
|
||
| **人员列表** | 展示所有人员信息，支持搜索与筛选。 | 支持按姓名、职位、状态（启用/禁用）筛选。 |
|
||
| **新增人员** | 管理员创建新账号。 | **必填：** 姓名、登陆账号、登陆密码、职位<br>**选填：** 联系方式、电子邮箱、描述<br>**默认：** 状态为“启用” |
|
||
| **编辑人员** | 修改现有人员信息。 | 管理员可修改所有字段；用户本人仅可修改联系方式、邮箱、描述。**账号与密码由管理员重置。** |
|
||
| **删除人员** | 物理或逻辑删除人员。 | 建议采用**逻辑删除**（标记为离职），保留历史日志关联。 |
|
||
| **启用/禁用** | 控制账号登陆权限。 | 禁用后，该账号无法登陆，历史数据保留。 |
|
||
| **安全要求** | 密码存储与传输。 | 密码需加密存储（如 BCrypt），传输全程 HTTPS。 |
|
||
|
||
### 3.2 工作日志信息管理模块
|
||
**目标：** 核心业务模块，记录每日工作内容。
|
||
|
||
| 功能点 | 详细描述 | 字段/规则 |
|
||
| :--- | :--- | :--- |
|
||
| **日志列表** | 展示日志记录，支持多端查看。 | 按日期倒序排列。支持按日期范围、记录人筛选（管理员）。 |
|
||
| **新建日志** | 填写当日工作内容。 | **日志日期：** 默认当天，可补填过去日期。<br>**记录时间：** 系统自动获取提交时间。<br>**记录人：** 自动获取当前登陆用户。<br>**使用模板：** 可选，选择后自动填充内容框架。<br>**记录内容：** 支持 Markdown 编辑器，**上限 2000 汉字**（含标点）。 |
|
||
| **编辑日志** | 修改已提交的日志。 | 仅允许修改**当日**或**未锁定**的日志（具体规则可配）。<br>内容修改需保留版本记录（可选）。 |
|
||
| **删除日志** | 移除错误记录。 | 仅本人可删除本人日志，管理员可删除任意日志。需二次确认。 |
|
||
| **查看详情** | 阅读日志具体内容。 | 渲染 Markdown 格式，显示模板名称（如有）。 |
|
||
| **数据校验** | 内容长度限制。 | 前端与后端双重校验，超过 2K 汉字禁止提交并提示。 |
|
||
|
||
### 3.3 日志模板管理模块
|
||
**目标：** 标准化日志格式，提高填写效率。
|
||
|
||
| 功能点 | 详细描述 | 字段/规则 |
|
||
| :--- | :--- | :--- |
|
||
| **模板列表** | 展示所有可用模板。 | 显示模板名称、状态、更新时间。 |
|
||
| **新增模板** | 创建新的日志格式。 | **模板名称：** 唯一标识（如“研发日报”、“销售周报”）。<br>**模板内容：** 支持 Markdown 语法的预设文本。<br>**使用说明：** 指导员工如何填写该模板。 |
|
||
| **编辑模板** | 更新模板内容。 | 修改后，新建日志时生效，不影响历史已提交的日志内容。 |
|
||
| **删除模板** | 移除废弃模板。 | 若模板已被日志引用，建议仅“禁用”而非物理删除。 |
|
||
| **启用/禁用** | 控制模板在前端的可见性。 | 禁用后，员工新建日志时无法选择该模板。 |
|
||
|
||
### 3.4 多终端服务
|
||
**目标：** 满足不同场景下的使用需求。
|
||
|
||
| 终端 | 适用场景 | 功能侧重 | 技术要求 |
|
||
| :--- | :--- | :--- | :--- |
|
||
| **管理后台 (Web)** | 办公室、管理场景 | 人员管理、模板配置、数据导出、全量日志查询。 | 响应式布局，适配 Chrome/Edge/Safari。 |
|
||
| **移动端 (Mobile)** | 外勤、居家、碎片时间 | 快速写日志、查看本人历史、接收提醒。 | 适配 iOS/Android，建议采用 H5 或微信小程序架构，免安装。 |
|
||
|
||
---
|
||
|
||
## 4. 非功能性需求 (NFR)
|
||
|
||
### 4.1 性能要求
|
||
* **响应时间：** 页面加载时间 < 1.5 秒（4G/5G 网络下）。
|
||
* **并发支持：** 支持至少 500 人同时在线操作（满足 2026 年规模预估）。
|
||
* **存储限制：** 单条日志内容严格限制在 2K 汉字以内，防止数据库膨胀。
|
||
|
||
### 4.2 安全与合规
|
||
* **数据加密：** 敏感信息（密码、联系方式）数据库加密存储。
|
||
* **访问控制：** 接口需具备 Token 鉴权机制，防止未授权访问。
|
||
* **操作审计：** 管理员的敏感操作（如删除人员、禁用账号）需记录操作日志。
|
||
* **隐私合规：** 符合《个人信息保护法》要求，提供账号注销或数据导出功能。
|
||
|
||
### 4.3 可靠性
|
||
* **数据备份：** 每日自动增量备份，每周全量备份。
|
||
* **异常处理：** 移动端在网络不佳时，支持草稿箱本地暂存功能。
|
||
|
||
---
|
||
|
||
## 5. 数据模型设计 (ER 简述)
|
||
|
||
为满足需求，核心数据表结构设计如下：
|
||
|
||
1. **用户表 (sys_user)**
|
||
* `id` (PK), `username`, `password_hash`, `name`, `phone`, `email`, `position`, `description`, `status` (0-禁用，1-启用), `created_at`
|
||
2. **日志模板表 (log_template)**
|
||
* `id` (PK), `title`, `content`, `instruction`, `status` (0-禁用，1-启用), `created_by`, `updated_at`
|
||
3. **工作日志表 (work_log)**
|
||
* `id` (PK), `user_id` (FK), `log_date`, `record_time`, `content`, `template_id` (FK, Nullable), `created_at`, `updated_at`
|
||
|
||
---
|
||
|
||
## 6. UI/UX 交互建议
|
||
|
||
1. **风格：** 简洁商务风，支持深色模式（Dark Mode），适应 2026 年主流操作系统特性。
|
||
2. **编辑器：** 移动端 Markdown 编辑器需简化 toolbar，提供常用快捷键（如加粗、列表、引用）。
|
||
3. **模板选择：** 新建日志时，模板选择采用弹窗或下拉式，支持“最近使用”推荐。
|
||
4. **字数统计：** 编辑器右下角实时显示当前字数/2000 字数，接近上限时变红预警。
|
||
|
||
---
|
||
|
||
## 7. 实施路线图 (Roadmap)
|
||
|
||
* **阶段一：基础架构与人员管理 (T+1 月)**
|
||
* 完成数据库设计、API 开发。
|
||
* 实现 Web 端人员增删改查及登陆认证。
|
||
* **阶段二：日志与模板核心功能 (T+2 月)**
|
||
* 完成日志 CRUD、Markdown 解析。
|
||
* 完成模板管理功能。
|
||
* Web 端管理后台上线。
|
||
* **阶段三：移动端适配与测试 (T+3 月)**
|
||
* 完成移动端 H5/小程序开发。
|
||
* 进行安全测试与压力测试。
|
||
* 小范围试点运行。
|
||
* **阶段四：全面推广 (2026 年初)**
|
||
* 全员培训，正式切换使用。
|
||
|
||
---
|
||
|
||
## 8. 风险与应对
|
||
|
||
| 风险点 | 描述 | 应对策略 |
|
||
| :--- | :--- | :--- |
|
||
| **内容限制过严** | 2K 汉字可能无法满足部分复杂工作记录。 | 在 V1.0 严格执行，V2.0 评估是否支持附件上传或扩容。 |
|
||
| **移动端体验** | Markdown 在手机上编辑体验较差。 | 优化移动端编辑器 UI，提供“纯文本模式”切换。 |
|
||
| **数据迁移** | 若从旧系统迁移，数据格式可能不兼容。 | 提供 Excel 导入/导出功能，便于初期数据初始化。 |
|
||
|
||
---
|
||
|
||
**审批签字：**
|
||
|
||
产品经理：________________ 日期：________________
|
||
技术负责人：______________ 日期：________________
|
||
业务方代表：______________ 日期：________________ |