提交 19684a0c authored 作者: yujiejie's avatar yujiejie

导师端验收界面优化1.0

上级 898c7a8f
---
name: function-module-checklist
description: 编写跨项目可复用的"功能模块清单"(Excel/Markdown 表格),按固定 12 列表头逐模块拆解业务功能。当用户要求"整理功能清单""编写功能模块清单""按 XX 表头写功能清单""总结功能模块"时触发。适用于任意平台/项目,依据原型图、设计稿或原型代码输出开发交付文档。
---
# 功能模块清单编写 Skill
根据原型图 / 原型代码 / 设计稿,输出一份**以原型为准**的功能模块清单(Excel `.xlsx` 或 Markdown 表格),表头固定为 **12 列**。
**核心原则(适用于任意项目):**
- 字段一律使用**界面可见的中文标签**,不使用代码变量名;
- 以原型为准,但原型未体现的细节由 AIPM 主动补齐;
- 角色前缀、模块命名、字段内容随项目不同而变化,本 Skill 只约束**填写规则**,不绑定任何具体业务。
## 固定表头(12 列,顺序不可变)
```
模块/页面 | 需求说明 | 交互规则 | 处理规则 | 前端职责边界 | 后端职责边界 | 数据来源/入参 | 产出/结果 | 状态流转 | 交付口径 | 验收标准 | 优先级
```
## 每列填写规则
### 1. 模块/页面
- 格式:`角色 + 页面中文名`,换行后括号内标注页面 ID(原型代码中的标识符)。
- 角色前缀由项目决定(如:用户端 / 管理端 / 公共;学员端 / 导师端 / 管理员端;C 端 / B 端)。
- 功能性子模块(不独占页面的)直接按功能命名,如 `[功能名]([子项])`。
```text
[角色]端 [页面中文名]
([page-id])
```
### 2. 需求说明
- **一句话**概述该模块的功能目标,句式:**谁 + 做什么 + 达成什么结果**。
- 不写按钮、不写细节、不写交互步骤。
```text
用户查看任务详情,填写并提交[业务对象],提交后进入[审核/验收]流程。
```
### 3. 交互规则(用户操作视角,逐步展开)
- 用 `① ② ③ …` 编号,**按用户操作顺序**从进入页面到离开页面逐条列出。
- 每条 = 操作动作 + 触发结果,如「点击『测试』按钮校验配置是否可用」。
- 覆盖主要分支:成功 / 失败 / 不同状态下按钮文案变化等。
- 编号步骤之间用换行分隔。
```text
① 查看[信息](只读)
② 添加 / 编辑 / 删除[业务对象],可设为默认
③ [关联信息]自动带出,可复制 / 预览
④ 点击「[操作]」判断[状态]
⑤ 点击「[跳转]」进入[下一环境]
```
### 4. 处理规则(系统逻辑视角)
- 描述**系统/业务逻辑约束**,不是用户操作:条件判断、数据流、锁定规则、校验规则、必填规则、状态触发条件。
- 每条规则用分号 `;` 分隔,可并列多条。
```text
[对象 A]、[对象 B]互不干扰;保存为草稿不切换状态;提交后该栏锁定;全部提交后进入[状态];[敏感字段]提交后掩码展示。
```
> 区分:**交互规则**写"用户怎么操作",**处理规则**写"系统按什么逻辑处理、受什么约束"。
### 5. 前端职责边界
- 写页面**展示什么 + 提供什么控件**。
- 句式:`展示XXX;提供XXX按钮;提供XXX入口;提交后字段置为只读`。
- 只写前端 UI 职责,不写后端。
```text
展示[表单/列表]面板([字段1]、[字段2]、[字段3]);提供[保存/提交]按钮与状态徽章;提交后字段置为只读。
```
### 6. 后端职责边界 ⚠️ AIPM 主动规定,不从原型推导
- 此字段由 **AIPM(你)** 根据业务需求自行规定后端应提供的能力,**不依赖原型代码**。
- 即使原型是纯前端模拟、未接任何后端,也必须写出后端应承担的职责(原型阶段可标注"待后端开发"),**不要写"原型为前端模拟,无后端"**。
- 用动词短语罗列:`返回XXX、保存XXX、校验XXX、代理XXX、同步XXX、通知XXX`。
- 写好后端职责后,可注明该职责在原型中的现状(如"原型为前端模拟,待后端实现")作为补充说明。
```text
返回[数据];保存[记录];校验[业务规则];代理[外部请求];同步[状态]至[角色端];生成[通知]。
(原型为前端模拟,以上职责待后端开发实现。)
```
### 7. 数据来源/入参
- 列出页面所需的**输入字段**,全部使用**界面可见的中文标签**,**禁止写代码变量名**。
- 字段按界面展示顺序排列,用顿号 `、` 分隔;跨面板的字段可加括号标注归属(如 `左栏[对象A]:…;右栏[对象B]:…`)。
```text
[字段1]、[字段2]、[字段3]、[字段4]、[字段5]、[字段6]、[敏感字段]。
```
### 8. 产出/结果
- 列出该模块**产生/展示的结果物**:界面组件结果 + 数据结果。
- 句式:`XXX列表、XXX命令、XXX结果、XXX入口`。
```text
[信息]只读展示、[对象]卡片列表、[结果]预览、[操作]入口。
```
### 9. 状态流转
- 用状态机描述,符号规则:
- `→` 单向流转;
- `↔` 可双向/回退;
- 括号 `()` 内注明**触发条件**。
- 涉及多轮重提/驳回的必须写明 `(轮次 +1)`。
```text
未开始 → 已提交 → [审核中] → 已通过 / 已驳回 / 待补充;已驳回或待补充 →(修改重提)→ 待验收(轮次 +1)。
```
### 10. 交付口径
- 声明**交付范围与边界**:哪些做、哪些明确不做、数据是真实还是模拟、角色权限边界。
- 可用"不做XXX"句式写明排除项。
```text
[数据来源声明];[XX]为前端模拟,后续版本接入真实[数据/服务]。
```
```text
[角色A]为唯一[操作]端;[参数]临时调整不影响[对象];不在本期内交付[功能]。
```
### 11. 验收标准
- 写出**可验证**的行为标准,供 QA 直接按条检查。
- 句式:`可XXX;XXX正确;XXX展示;XXX后锁定`。
```text
可添加/编辑/删除/设为默认;[关联信息]自动带出;[敏感信息]展示需脱敏;提交后锁定。
```
### 12. 优先级
- `P0 / P1 / P2`。核心主链路为 P0,增强/辅助功能为 P1,远期为 P2。
## 工作流
1. **定位原型来源**:读取原型代码(如 `index.html`、`pages-*.js`)或设计稿,确认角色端与页面清单(**角色端与页面名随项目变化,从项目原型中获取,不预设**)。
2. **识别模块**:按页面拆分模块;无独立页面但有独立功能的逻辑块(如测试、评分、通知联动)单独成行。
3. **提取字段**:遍历页面可看到的表单/展示字段,用中文标签记录,不抄变量名。
4. **后端职责由 AIPM 规定**:结合业务需求编写后端职责边界,不从原型推导,原型未接后端时用"待后端开发"标注。
5. **按 12 列逐格填写**:严格遵循上述每列规则,一行一个模块。
6. **输出交付**:默认生成 Excel(`openpyxl`),表头固定 12 列,行高 140、列宽按内容调整、表头蓝底白字、首行标题 + 第二行说明;也可输出 Markdown 表格。
7. **交付前自检**:字段是否写成变量名(不合格);状态流转是否缺触发条件;列数是否少于 12;后端职责边界是否照抄原型(应体现 AIPM 规定的能力)。
## 输出脚本模板
生成 Excel 时使用如下骨架(表头固定,样式统一,**文件名、标题由项目自定义**):
```python
import openpyxl
from openpyxl.styles import Font, PatternFill, Alignment, Border, Side
from openpyxl.utils import get_column_letter
HEADER = ["模块/页面", "需求说明", "交互规则", "处理规则", "前端职责边界",
"后端职责边界", "数据来源/入参", "产出/结果", "状态流转", "交付口径",
"验收标准", "优先级"]
# ROWS = [ [12 个字段各一行], ... ]
wb = openpyxl.Workbook()
ws = wb.active
ws.title = "功能模块清单"
# 第 1 行:合并 12 列写标题(标题含项目名,如「[项目名] 功能模块清单」)
# 第 2 行:合并写说明(说明中标注:以原型为准,字段用界面可见中文标签)
# 第 4 行:表头(蓝底白字加粗);第 5 行起:每行一个模块,自动换行,浅灰边框
# 列宽建议:1-2 列 30-36,字段密集列 40-55,优先级列 10
```
## 项目适配说明
- **角色命名**:从项目原型中读取,勿默认"学生/导师"。
- **页面清单**:从原型代码/设计稿中提取,勿沿用其他项目的页面。
- **字段标签**:以当前项目界面可见文案为准。
- **示例**:本 Skill 内示例均为占位格式,实际填写时替换为当前项目的业务名词。
......@@ -156,7 +156,7 @@
| API 验收测试(进度汇总) | 当前任务各测试项状态(未测试/测试中/已通过/失败)+「去验收台」按钮 | `buildMentorDeployTestSummaryCard` + `tests.{...}` |
| 验收评分 | 5 项维度(API40/部署20/日志15/报告15/总结10),总分 100 自动计算 | `MENTOR_DEPLOY_SCORE_ITEMS` + `scores[taskKey][sid]` |
| 整体结论 | 通过 / 驳回 / 待补充 + 评语 + 保存草稿 + 提交通知 | `conclusion[sid]`、`comments[taskKey][sid]`、`submitMentorDeployReview()` |
| 历史记录 / 验收流程 | 历史轮次记录;无历史时显示三步验收流程引导 | `buildMentorDeployReviewHistoryHtml` / `buildMentorDeployReviewFlowGuide` |
| 历史记录 | 历史轮次记录;无历史记录时,中栏提交内容卡片「去验收台」按钮下方显示三步验收流程引导 | `buildMentorDeployReviewHistoryHtml` / `buildMentorDeployReviewFlowGuide` |
> 验收配置、验收参数与 API 测试卡片已迁移至独立验收台页面 `mentor-deploy-acceptance`,测试结果与参数草稿写入全局 `mentorDeployReviewState`,返回部署验收页自动同步。
......
......@@ -1572,7 +1572,7 @@ function buildMentorDeployContentTabs(sub) {
}).join('');
}
function buildMentorDeploySubmissionPanel(sub) {
function buildMentorDeploySubmissionPanel(sub, sid) {
var a = (sub && sub.artifact) || {};
var lg = (sub && sub.log) || {};
var r = (sub && sub.report) || {};
......@@ -1619,6 +1619,7 @@ function buildMentorDeploySubmissionPanel(sub) {
'<span class="inline-flex items-center justify-center gap-1.5"><svg class="w-4 h-4" data-lucide="terminal"></svg>去验收台<svg class="w-4 h-4" data-lucide="arrow-right"></svg></span>' +
'</button>' +
'<p class="text-xs text-[#86909C] mt-1.5 text-center">前往独立验收台完成真实 API 测试,测试结果自动同步回本页</p>' +
buildMentorDeployReviewFlowGuide(sid) +
'</div>' +
'</div>';
}
......@@ -2888,14 +2889,14 @@ function buildMentorDeployReviewFlowGuide(sid) {
{ title: '提交整体结论', desc: '通过 / 驳回 / 待补充三选一,填写评语后提交并通知学生。' }
];
var rows = steps.map(function(st, i) {
return '<div class="flex items-start gap-3">' +
'<span class="w-6 h-6 rounded-full bg-[#E8F3FF] text-[#165DFF] text-xs font-bold flex items-center justify-center flex-shrink-0 mt-0.5">' + (i + 1) + '</span>' +
'<div><div class="text-sm font-medium text-[#1D2129]">' + st.title + '</div><div class="text-xs text-[#86909C] mt-0.5">' + st.desc + '</div></div>' +
return '<div class="flex items-start gap-2.5">' +
'<span class="w-5 h-5 rounded-full bg-[#165DFF] text-white text-[11px] font-bold flex items-center justify-center flex-shrink-0 mt-0.5">' + (i + 1) + '</span>' +
'<div><div class="text-[13px] font-medium text-[#1D2129]">' + st.title + '</div><div class="text-xs text-[#86909C] mt-0.5 leading-relaxed">' + st.desc + '</div></div>' +
'</div>';
}).join('');
return '<div class="bg-white rounded-lg border border-[#E5E6EB] p-4 mb-4">' +
'<h3 class="font-semibold text-[#1D2129] mb-3">验收流程</h3>' +
'<div class="space-y-3">' + rows + '</div>' +
return '<div class="mt-3 rounded-lg bg-[#F7F8FA] border border-[#E5E6EB] p-3">' +
'<div class="flex items-center gap-1.5 mb-2"><svg class="w-4 h-4 text-[#165DFF]" data-lucide="clipboard-list"></svg><h3 class="text-sm font-semibold text-[#1D2129]">验收流程</h3></div>' +
'<div class="space-y-2.5">' + rows + '</div>' +
'</div>';
}
......@@ -2903,13 +2904,11 @@ function buildMentorDeployReviewPanel(student) {
if (!student) return '';
var sid = Number(student.id);
var locked = isMentorDeployReviewLocked(sid);
var leftHtml = buildMentorDeployReviewHistoryHtml(sid) + buildMentorDeployReviewFlowGuide(sid);
var rightHtml = buildMentorDeployTestSummaryCard(sid) +
(locked ? buildMentorDeployLockedReviewPanel(sid) : buildMentorDeployScoreCard(sid) + buildMentorDeployConclusionPanel(sid));
return '<div class="grid grid-cols-12 gap-4 items-start">' +
'<div class="col-span-7 min-w-0">' + leftHtml + '</div>' +
'<div class="col-span-5 min-w-0">' + rightHtml + '</div>' +
'</div>';
return '<div class="space-y-4">' +
buildMentorDeployReviewHistoryHtml(sid) +
buildMentorDeployTestSummaryCard(sid) +
(locked ? buildMentorDeployLockedReviewPanel(sid) : buildMentorDeployScoreCard(sid) + buildMentorDeployConclusionPanel(sid)) +
'</div>';
}
function getMentorDeployMissingApiTests(sid) {
......@@ -3104,7 +3103,7 @@ pageRenderers["mentor-deploy-review"] = function() {
'<span class="px-2.5 py-1 rounded-lg text-xs font-medium flex-shrink-0 ' + statusClass + '">' + status + '</span>' +
'</div>' +
buildMentorDeployCompletenessNotice(sub) +
buildMentorDeploySubmissionPanel(sub)
buildMentorDeploySubmissionPanel(sub, selected.id)
: '<div class="bg-white rounded-lg border border-[#E5E6EB] p-8 text-center text-[#86909C]">请先从左侧选择学生</div>';
return '<div class="max-w-[1500px] mx-auto">' +
'<div class="flex items-center justify-between mb-6">' +
......@@ -3119,13 +3118,13 @@ pageRenderers["mentor-deploy-review"] = function() {
'</div>' +
'</div>' +
'<div class="flex items-center gap-3 mb-6">' + buildMentorDeployTaskTabs(selectedId) + '</div>' +
'<div class="grid grid-cols-12 gap-6">' +
'<div class="col-span-3 bg-white rounded-lg border border-[#E5E6EB] p-4 self-start">' +
'<div class="grid grid-cols-[280px_minmax(0,1fr)_420px] gap-6 items-start">' +
'<div class="bg-white rounded-lg border border-[#E5E6EB] p-4 self-start">' +
'<div class="flex items-center justify-between mb-3"><h3 class="font-semibold text-[#1D2129]">我的学生</h3><span class="text-xs px-2 py-0.5 rounded bg-[#F2F3F5] text-[#86909C]">' + students.length + ' 人</span></div>' +
(listHtml || '<div class="py-10 text-center text-sm text-[#86909C]">暂无负责学生</div>') +
'</div>' +
'<div class="col-span-4 min-w-0">' + contentHtml + '</div>' +
'<div class="col-span-5 min-w-0">' + buildMentorDeployReviewPanel(selected) + '</div>' +
'<div class="min-w-0">' + contentHtml + '</div>' +
'<div class="min-w-0">' + buildMentorDeployReviewPanel(selected) + '</div>' +
'</div></div>';
};
......@@ -3158,9 +3157,9 @@ pageRenderers["mentor-deploy-acceptance"] = function() {
'<span class="px-3 py-1.5 rounded-lg text-sm font-medium flex-shrink-0 ' + statusClass + '">' + status + '</span>' +
'</div>' +
'<div class="flex items-center gap-3 mb-6">' + buildMentorDeployTaskTabs(selectedId) + '</div>' +
'<div class="grid grid-cols-12 gap-6 items-start">' +
'<div class="col-span-3 min-w-0">' + buildMentorDeployGlobalConfig(sid) + buildMentorDeployParamsPanel(sid) + '</div>' +
'<div class="col-span-9 min-w-0">' + itemsHtml + '</div>' +
'<div class="grid grid-cols-[320px_minmax(0,1fr)] gap-6 items-start">' +
'<div class="min-w-0">' + buildMentorDeployGlobalConfig(sid) + buildMentorDeployParamsPanel(sid) + '</div>' +
'<div class="min-w-0">' + itemsHtml + '</div>' +
'</div>' +
'</div>';
};
......
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑!
请 注册 或者 后发表评论