|
|
---
|
|
|
name: 详细功能说明文档编写
|
|
|
overview: 基于全部项目文档要求，按照02-功能清单-*.md的4个端侧（小程序端、物业公司、医院、超级管理员），创建对应文件夹，每个功能菜单拆分为独立.md文件，包含页面名称、页面元素、查询条件、列表字段、界面布局，以及需求追溯和功能关联。
|
|
|
todos:
|
|
|
- id: create-folders
|
|
|
content: 创建4个功能说明文件夹
|
|
|
status: completed
|
|
|
- id: write-super-admin
|
|
|
content: 编写超级管理员功能说明（4个文件）
|
|
|
status: completed
|
|
|
dependencies:
|
|
|
- create-folders
|
|
|
- id: write-property
|
|
|
content: 编写物业公司功能说明（9个文件）
|
|
|
status: completed
|
|
|
dependencies:
|
|
|
- create-folders
|
|
|
- id: write-hospital
|
|
|
content: 编写医院功能说明（5个文件）
|
|
|
status: completed
|
|
|
dependencies:
|
|
|
- create-folders
|
|
|
- id: write-miniprogram
|
|
|
content: 编写小程序端功能说明（9个文件）
|
|
|
status: completed
|
|
|
dependencies:
|
|
|
- create-folders
|
|
|
---
|
|
|
|
|
|
## 产品概述
|
|
|
|
|
|
基于现有项目文档（01~06号文档），编写4套详细功能说明文档，覆盖全部角色端的功能页面设计。
|
|
|
|
|
|
## 核心功能
|
|
|
|
|
|
- 按照02-功能清单的4个文件名创建4个文件夹：超级管理员、物业公司、医院、小程序端
|
|
|
- 每个功能菜单独立一个.md文件，共约27个文件
|
|
|
- 每个文件包含：菜单/子菜单/页面名称、页面元素、查询条件、列表字段、界面布局描述
|
|
|
- 每个功能标注：对应文档要求来源、后续服务功能、关联功能
|
|
|
- 所有设计需满足01-模块划分、03-业务流转逻辑、05-接口规范、06-项目技术要求中定义的约束
|
|
|
|
|
|
## 文件统计
|
|
|
|
|
|
- 02-功能清单-超级管理员/：4个文件（账号管理、权限管理、系统配置、操作日志）
|
|
|
- 02-功能清单-物业公司/：9个文件（在线报修、巡检管理、保洁管理、组织架构、考勤打卡、服务评价、统计报表、操作日志、系统配置）
|
|
|
- 02-功能清单-医院/：5个文件（合同管理、分段招标管理、服务监督、服务评价、统计报表）
|
|
|
- 02-功能清单-小程序端/：9个文件（通用功能、报修、巡检、保洁、考勤、组织架构、服务评价、统计概览、管理员功能）
|
|
|
|
|
|
## 文档编写规范
|
|
|
|
|
|
### 单文件模板结构
|
|
|
|
|
|
每个.md文件遵循统一模板：
|
|
|
|
|
|
```
|
|
|
# {菜单名称}
|
|
|
|
|
|
> 模块编码：{module code}
|
|
|
> 端侧：Web/小程序
|
|
|
> 关联文档：列出关联的01~06号文档章节
|
|
|
|
|
|
## 功能概览
|
|
|
| 项目 | 说明 |
|
|
|
|------|------|
|
|
|
| 菜单名称 | |
|
|
|
| 子菜单 | |
|
|
|
| 功能编号 | 如 PR-R-01~11 |
|
|
|
| 权限编码 | 如 repair:list:* |
|
|
|
|
|
|
## 页面清单
|
|
|
|
|
|
### 页面N：{页面名称}
|
|
|
- **页面路径**：路由路径
|
|
|
- **页面元素**：表单字段、按钮、标签页等
|
|
|
- **查询条件**：筛选器列表
|
|
|
- **列表字段**：表格列定义
|
|
|
- **界面布局**：文字描述布局结构
|
|
|
- **操作按钮**：可用动作及权限要求
|
|
|
|
|
|
## 需求追溯
|
|
|
| 功能点编号 | 功能名称 | 文档来源 | 后续服务 | 关联功能 |
|
|
|
|------------|----------|----------|----------|----------|
|
|
|
|
|
|
## 业务规则
|
|
|
- 从03-业务流转逻辑和06-项目技术要求中提取的约束
|
|
|
|
|
|
## 状态流转（如有）
|
|
|
- 状态机定义
|
|
|
```
|
|
|
|
|
|
### 需求追溯规范
|
|
|
|
|
|
- **文档来源**：标注来自哪个文档的哪个编号，如"02-物业公司 PR-R-01"、"03-物业公司 1.2节"、"06-技术要求 4.4节"
|
|
|
- **后续服务**：该功能完成后触发的下游服务，如"工单分配→触发通知服务"
|
|
|
- **关联功能**：与本功能有数据依赖或交互的其他功能，如"工单列表↔巡检异常上报"
|
|
|
|
|
|
### 数据来源
|
|
|
|
|
|
所有页面设计的数据字段从以下文档综合提取：
|
|
|
|
|
|
- 01-模块划分.md：角色权限、数据范围
|
|
|
- 02-功能清单-*.md：功能点编号和描述
|
|
|
- 03-业务流转逻辑-*.md：流转规则、状态定义、补录标记字段
|
|
|
- 05-接口规范.md：权限编码矩阵（第九章）、模块事件定义
|
|
|
- 06-项目技术要求.md：蓝牙策略、审计日志、四级权限体系
|
|
|
|
|
|
### 目录结构
|
|
|
|
|
|
```
|
|
|
docs/
|
|
|
├── 02-功能清单-超级管理员/
|
|
|
│ ├── 01-账号管理.md # SA-A-01~08，含医院/物业账号CRUD、有效期、到期管理
|
|
|
│ ├── 02-权限管理.md # SA-P-01~10，含角色定义、权限分配、预设模板、审计日志
|
|
|
│ ├── 03-系统配置.md # SA-S-01~02，含版本管理、缓存管理
|
|
|
│ └── 04-操作日志.md # SA-L-01~02，含权限变更日志、账号操作日志
|
|
|
├── 02-功能清单-物业公司/
|
|
|
│ ├── 01-在线报修.md # PR-R-01~11，含工单列表/详情/分配/流转/延期/补录/导出
|
|
|
│ ├── 02-巡检管理.md # PR-I-01~07，含计划/看板/记录/异常/区域/补录
|
|
|
│ ├── 03-保洁管理.md # PR-C-01~08，含区域/看板/排班/蓝牙/超时/抽查/补录
|
|
|
│ ├── 04-组织架构.md # PR-O-01~11，含班组/人员/排班/技能/打卡点/下属账号
|
|
|
│ ├── 05-考勤打卡.md # PR-A-01~05，含打卡点/规则/记录/异常审核/补录
|
|
|
│ ├── 06-服务评价.md # PR-E-01~05，含汇总/列表/回复/绩效/配置
|
|
|
│ ├── 07-统计报表.md # PR-ST-01~07，含报修/巡检/保洁/评价/考勤/综合/自定义
|
|
|
│ ├── 08-操作日志.md # PR-AL-01~05，含时间轴/列表/详情/导出/补录日志
|
|
|
│ └── 09-系统配置.md # PR-S-01~05，含蓝牙设备/字典/微信/消息模板/补录审核
|
|
|
├── 02-功能清单-医院/
|
|
|
│ ├── 01-合同管理.md # HO-CT-01~11，含台账/录入/审批/付款/变更/预警/续签
|
|
|
│ ├── 02-分段招标管理.md # HO-BD-01~09，含计划/标段/供应商/发布/投标/评标/定标
|
|
|
│ ├── 03-服务监督.md # HO-SP-01~04，含报修/巡检/保洁数据只读查看
|
|
|
│ ├── 04-服务评价.md # HO-EV-01~03，含发起评价/汇总查看/列表查看
|
|
|
│ └── 05-统计报表.md # HO-ST-01~08，含业务/合同/招标/综合/自定义报表
|
|
|
└── 02-功能清单-小程序端/
|
|
|
├── 01-通用功能.md # MP-C-01~06，含登录/个人信息/消息/补录/版本/通讯录
|
|
|
├── 02-报修相关功能.md # MP-R-01~12，含扫码/报修/工单/催单/接单/完工/延期/验收/评价
|
|
|
├── 03-巡检相关功能.md # MP-I-01~06，含今日任务/蓝牙打卡/执行/异常上报/补录
|
|
|
├── 04-保洁相关功能.md # MP-CL-01~07，含今日任务/蓝牙打卡/执行/异常/抽查/补录
|
|
|
├── 05-考勤相关功能.md # MP-AT-01~06，含上下班打卡/记录/申诉/日历/审核
|
|
|
├── 06-组织架构相关功能.md # MP-OR-01~02，含我的班组/我的排班
|
|
|
├── 07-服务评价相关功能.md # MP-EV-01~03，含待评价/评分留言/历史评价
|
|
|
├── 08-统计概览功能.md # MP-ST-01~02，含简版概览/个人绩效
|
|
|
└── 09-管理员小程序功能.md # MP-PM-01~06，含报修/巡检/保洁/考勤/评价/组织架构管理
|
|
|
```
|
|
|
|
|
|
## Agent Extensions
|
|
|
|
|
|
### SubAgent
|
|
|
|
|
|
- **code-explorer**: 在编写功能说明时，快速检索项目文档中特定功能点的定义、流转规则和权限编码，确保文档内容与现有规范一致 |