5.5 KiB
JeecgBoot 工单案例包设计
日期:2026-07-01
目标
在现有 TRAE 培训课件之外,新增一个可独立分发、可插入第 3/4 天课程的 JeecgBoot 工单案例包。案例包用于训练学员把 TRAE 用在真实 JeecgBoot 类后台项目中,完成从项目理解、需求拆解、权限设计、状态流转、审计、异常态、看板到 Review 的完整工程链路。
范围
案例包存放在:
cases/jeecgboot-work-order/
新增文件:
cases/jeecgboot-work-order/
├── README.md
├── instructor-guide.md
├── learner-guide.md
├── source-map.md
├── prompts.md
├── worksheets.md
├── acceptance-checklist.md
└── assets-index.md
不修改现有 Slidev 主课件,不修改 JeecgBoot 项目源码,不生成工单模块代码。案例包是培训资料资产,不是代码实现任务。
已观察来源
TRAE 培训大纲V1.0.md:定义 6 天课程主线和 JeecgBoot 工单训练主题。第 3 天:TRAE 能力体系与 Agent 工作方式.md:后半段已承接 JeecgBoot 工单、Plan、Review、Browser 验证。第 4 天:JeecgBoot 工单复杂业务开发:权限、审计、异常态与看板.md:已有完整复杂业务讲法和交付物。slidev/slides.md:当前 Slidev 主线已包含第 1-4 天,不纳入本次修改范围。../../../JeecgBoot/docs/project-knowledge/README.md:JeecgBoot 项目知识库入口。../../../JeecgBoot/jeecg-boot/CLAUDE.md:后端项目约束、模块结构、修改痕迹规则。../../../JeecgBoot/jeecgboot-vue3/CLAUDE.md:前端项目约束、路由、Pinia、API 层、构建命令。
内容设计
README.md
案例包入口。说明适用对象、建议课时、学习目标、使用顺序、项目准备、交付物清单。
核心作用:让讲师和学员知道这个包怎么用。
instructor-guide.md
讲师手册。包含 2 小时、半天、1 天三种授课节奏,讲解重点、提问方式、演示路径、常见翻车点和收束话术。
核心作用:让讲师不用重新组织课堂流程。
learner-guide.md
学员手册。按步骤指导学员使用 TRAE 完成案例任务:读项目、定位源码、拆需求、设计权限、设计状态流转、补审计、列异常态、做看板、做 Review。
核心作用:让学员可以独立完成实操。
source-map.md
源码定位图。按主题列出 JeecgBoot 前端、后端、权限、路由、配置、数据库和知识库入口路径。
核心作用:避免学员和 TRAE 泛泛总结项目,强制回到实际路径。
prompts.md
Prompt 模板库。覆盖:
- 项目理解
- 源码定位
- 需求拆解
- 接口契约
- RBAC 权限矩阵
- 权限落地检查
- 状态机设计
- 审计日志设计
- 异常态清单
- 看板指标
- 代码修改计划
- Review 与验收
核心作用:提供课堂可直接复制的 TRAE 提问模板。
worksheets.md
课堂填写表。包含需求拆解表、上下文包、源码依据记录表、接口契约表、权限矩阵、状态流转表、异常态清单、看板指标表、Review 记录表。
核心作用:让课堂产出标准化。
acceptance-checklist.md
验收清单。按理解、设计、实现计划、验证、资产沉淀五类检查学员产出。
核心作用:判断学员是否真的掌握,而不是只让 AI 生成了一段内容。
assets-index.md
资产归档建议。说明哪些内容适合沉淀为团队规则、Prompt、Command、Skill、案例库、SOP。
核心作用:把一次课堂实操转成可复用企业资产。
关键约束
- 所有非显而易见的项目事实必须引用实际路径。
- 工单模块是教学案例,不假设当前 JeecgBoot 源码中已经存在完整工单模块。
- Prompt 必须要求 TRAE 区分事实、推断和建议。
- Prompt 必须要求 TRAE 先找依据,再给结论,不允许直接改代码。
- 涉及权限、状态流转、审计、删除、数据看板的任务必须先产出计划和验收点。
- 后端二开说明必须提醒遵守
jeecg-boot/CLAUDE.md中的update-begin/update-end修改痕迹规则。 - 前端说明必须提醒遵守
jeecgboot-vue3/CLAUDE.md中的/@/alias、Pinia、动态路由和defHttpAPI 层约定。 - 不新增第 5/6 天课件,不改
slidev/slides.md。
产出质量标准
- 新人能根据
README.md判断使用顺序。 - 讲师能根据
instructor-guide.md开始授课。 - 学员能根据
learner-guide.md完成一轮工单案例设计。 source-map.md能把学员从“泛泛问项目”引导到具体源码路径。prompts.md的模板能直接复制使用,并包含输入、约束、输出格式和验收要求。worksheets.md的表格能承接课堂产出。acceptance-checklist.md能用于小组展示验收。assets-index.md能指导课后资产沉淀。
非目标
- 不实现真实工单模块。
- 不安装依赖、不启动 JeecgBoot。
- 不生成数据库迁移 SQL。
- 不改现有课件结构。
- 不替换第 4 天逐字稿。
- 不把案例包写入
JeecgBoot/docs/project-knowledge/,避免培训资料和项目知识库混合。
未知与风险
- 当前
TRAE课件工作区已有未提交改动,本次只新增案例包和设计说明,不处理既有改动。 - JeecgBoot 目录不是 Git 仓库,案例包中的源码路径按当前本地目录快照编写。
- 若后续要让学员真正生成并运行工单模块,还需要另行准备数据库、账号、菜单权限和初始数据脚本。