smart
424 lines
8.0 KiB
Markdown
424 lines
8.0 KiB
Markdown
# JeecgBoot Work Order Case Pack Implementation Plan
|
|
|
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
|
|
|
**Goal:** Create an independent JeecgBoot work-order training case pack under `cases/jeecgboot-work-order/`.
|
|
|
|
**Architecture:** This is a documentation-only training asset. The case pack is split into an entry README, role-specific guides, a source map, prompt templates, worksheets, an acceptance checklist, and an asset index. It references the local JeecgBoot project and existing TRAE course materials without changing either.
|
|
|
|
**Tech Stack:** Markdown, local JeecgBoot source paths, existing TRAE course docs.
|
|
|
|
---
|
|
|
|
## File Structure
|
|
|
|
- Create: `cases/jeecgboot-work-order/README.md`
|
|
- Case pack entry, learning goals, audience, timing, usage order, required project context, final deliverables.
|
|
- Create: `cases/jeecgboot-work-order/instructor-guide.md`
|
|
- Teaching agenda for 2-hour, half-day, and full-day variants, with facilitation notes and common failure modes.
|
|
- Create: `cases/jeecgboot-work-order/learner-guide.md`
|
|
- Student-facing lab path from project reading to final review.
|
|
- Create: `cases/jeecgboot-work-order/source-map.md`
|
|
- Source-grounded JeecgBoot path map for backend, frontend, permissions, routes, config, database, and project knowledge docs.
|
|
- Create: `cases/jeecgboot-work-order/prompts.md`
|
|
- Copy-ready TRAE prompts with inputs, constraints, and output formats.
|
|
- Create: `cases/jeecgboot-work-order/worksheets.md`
|
|
- Fillable classroom templates for requirements, source evidence, APIs, RBAC, state transitions, audit, dashboard, and review.
|
|
- Create: `cases/jeecgboot-work-order/acceptance-checklist.md`
|
|
- Checklist for evaluating learner output.
|
|
- Create: `cases/jeecgboot-work-order/assets-index.md`
|
|
- Post-class asset library mapping for rules, prompts, commands, skills, SOPs, and cases.
|
|
|
|
## Task 1: Create Case Pack Directory
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/`
|
|
|
|
- [ ] **Step 1: Create the directory**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
mkdir -p cases/jeecgboot-work-order
|
|
```
|
|
|
|
Expected: directory exists.
|
|
|
|
- [ ] **Step 2: Verify the directory**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
find cases -maxdepth 2 -type d | sort
|
|
```
|
|
|
|
Expected includes:
|
|
|
|
```text
|
|
cases
|
|
cases/jeecgboot-work-order
|
|
```
|
|
|
|
## Task 2: Write Entry README
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/README.md`
|
|
|
|
- [ ] **Step 1: Write README**
|
|
|
|
Include these sections:
|
|
|
|
```markdown
|
|
# JeecgBoot 工单案例包
|
|
|
|
## 适用场景
|
|
|
|
## 学习目标
|
|
|
|
## 建议使用顺序
|
|
|
|
## 课前准备
|
|
|
|
## 案例任务主线
|
|
|
|
## 最终交付物
|
|
|
|
## 关键约束
|
|
|
|
## 文件索引
|
|
```
|
|
|
|
- [ ] **Step 2: Check README links**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "\\[[^\\]]+\\]\\(([^)]+)\\)" cases/jeecgboot-work-order/README.md
|
|
```
|
|
|
|
Expected: all relative links point to files created in this plan.
|
|
|
|
## Task 3: Write Instructor And Learner Guides
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/instructor-guide.md`
|
|
- Create: `cases/jeecgboot-work-order/learner-guide.md`
|
|
|
|
- [ ] **Step 1: Write instructor guide**
|
|
|
|
Include:
|
|
|
|
```markdown
|
|
# 讲师手册
|
|
|
|
## 授课定位
|
|
|
|
## 2 小时版本
|
|
|
|
## 半天版本
|
|
|
|
## 1 天版本
|
|
|
|
## 演示路径
|
|
|
|
## 讲师提醒
|
|
|
|
## 常见翻车点
|
|
|
|
## 收束话术
|
|
```
|
|
|
|
- [ ] **Step 2: Write learner guide**
|
|
|
|
Include:
|
|
|
|
```markdown
|
|
# 学员实操手册
|
|
|
|
## 实操目标
|
|
|
|
## 第 1 步：建立项目地图
|
|
|
|
## 第 2 步：整理工单需求
|
|
|
|
## 第 3 步：定位源码依据
|
|
|
|
## 第 4 步：设计接口契约
|
|
|
|
## 第 5 步：设计权限和状态流转
|
|
|
|
## 第 6 步：补齐审计和异常态
|
|
|
|
## 第 7 步：设计看板指标
|
|
|
|
## 第 8 步：做 Review 和交付验收
|
|
```
|
|
|
|
- [ ] **Step 3: Verify guides reference worksheets and prompts**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "prompts.md|worksheets.md|source-map.md|acceptance-checklist.md" cases/jeecgboot-work-order/instructor-guide.md cases/jeecgboot-work-order/learner-guide.md
|
|
```
|
|
|
|
Expected: both guides reference supporting files.
|
|
|
|
## Task 4: Write Source Map
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/source-map.md`
|
|
|
|
- [ ] **Step 1: Write source map**
|
|
|
|
Include source-grounded tables for:
|
|
|
|
```markdown
|
|
# 源码定位图
|
|
|
|
## 项目知识库入口
|
|
|
|
## 后端入口与模块
|
|
|
|
## 前端入口与模块
|
|
|
|
## 权限与路由
|
|
|
|
## API 与请求层
|
|
|
|
## 配置与运行
|
|
|
|
## 数据库与迁移
|
|
|
|
## 课堂使用方式
|
|
```
|
|
|
|
- [ ] **Step 2: Verify referenced local paths exist**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -o "`\\.\\./JeecgBoot/[^`]+`" cases/jeecgboot-work-order/source-map.md
|
|
```
|
|
|
|
Then manually confirm representative paths exist with `test -e` or `ls`.
|
|
|
|
## Task 5: Write Prompt Library
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/prompts.md`
|
|
|
|
- [ ] **Step 1: Write prompt templates**
|
|
|
|
Include prompts for:
|
|
|
|
```markdown
|
|
# Prompt 模板库
|
|
|
|
## 使用规则
|
|
|
|
## 项目理解 Prompt
|
|
|
|
## 源码定位 Prompt
|
|
|
|
## 需求拆解 Prompt
|
|
|
|
## 接口契约 Prompt
|
|
|
|
## RBAC 权限矩阵 Prompt
|
|
|
|
## 权限落地检查 Prompt
|
|
|
|
## 状态机设计 Prompt
|
|
|
|
## 审计日志 Prompt
|
|
|
|
## 异常态 Prompt
|
|
|
|
## 看板指标 Prompt
|
|
|
|
## 修改计划 Prompt
|
|
|
|
## Review Prompt
|
|
```
|
|
|
|
Each prompt must require TRAE to output:
|
|
|
|
```text
|
|
事实依据
|
|
推断
|
|
建议
|
|
不确定点
|
|
下一步验证
|
|
```
|
|
|
|
- [ ] **Step 2: Verify prompt safety wording**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "先找依据|事实|推断|建议|不确定点|不要直接改代码|验收" cases/jeecgboot-work-order/prompts.md
|
|
```
|
|
|
|
Expected: all key safety constraints are present.
|
|
|
|
## Task 6: Write Worksheets
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/worksheets.md`
|
|
|
|
- [ ] **Step 1: Write worksheets**
|
|
|
|
Include fillable tables:
|
|
|
|
```markdown
|
|
# 课堂工作表
|
|
|
|
## 上下文包
|
|
|
|
## 源码依据记录表
|
|
|
|
## 需求拆解表
|
|
|
|
## 接口契约表
|
|
|
|
## RBAC 权限矩阵
|
|
|
|
## 状态流转表
|
|
|
|
## 审计日志设计表
|
|
|
|
## 异常态清单
|
|
|
|
## 看板指标表
|
|
|
|
## Review 记录表
|
|
|
|
## 最终交付记录
|
|
```
|
|
|
|
- [ ] **Step 2: Verify tables are fillable**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "\\|.*\\|.*\\|" cases/jeecgboot-work-order/worksheets.md
|
|
```
|
|
|
|
Expected: each worksheet section contains a Markdown table.
|
|
|
|
## Task 7: Write Acceptance Checklist And Asset Index
|
|
|
|
**Files:**
|
|
- Create: `cases/jeecgboot-work-order/acceptance-checklist.md`
|
|
- Create: `cases/jeecgboot-work-order/assets-index.md`
|
|
|
|
- [ ] **Step 1: Write acceptance checklist**
|
|
|
|
Include:
|
|
|
|
```markdown
|
|
# 验收清单
|
|
|
|
## 项目理解
|
|
|
|
## 需求与接口
|
|
|
|
## 权限与状态
|
|
|
|
## 审计、异常态与看板
|
|
|
|
## Review 与交付
|
|
|
|
## 评分建议
|
|
```
|
|
|
|
- [ ] **Step 2: Write asset index**
|
|
|
|
Include:
|
|
|
|
```markdown
|
|
# 资产归档索引
|
|
|
|
## 可沉淀资产
|
|
|
|
## 目录建议
|
|
|
|
## 规则资产
|
|
|
|
## Prompt 资产
|
|
|
|
## Command 与 Skill 资产
|
|
|
|
## 案例库资产
|
|
|
|
## 维护机制
|
|
```
|
|
|
|
- [ ] **Step 3: Verify checklist and assets are cross-linked**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "README.md|prompts.md|worksheets.md|acceptance-checklist.md|assets-index.md" cases/jeecgboot-work-order/acceptance-checklist.md cases/jeecgboot-work-order/assets-index.md
|
|
```
|
|
|
|
Expected: files reference related materials.
|
|
|
|
## Task 8: Final Verification
|
|
|
|
**Files:**
|
|
- Inspect all files under `cases/jeecgboot-work-order/`
|
|
|
|
- [ ] **Step 1: List generated files**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
find cases/jeecgboot-work-order -type f | sort
|
|
```
|
|
|
|
Expected exactly:
|
|
|
|
```text
|
|
cases/jeecgboot-work-order/README.md
|
|
cases/jeecgboot-work-order/acceptance-checklist.md
|
|
cases/jeecgboot-work-order/assets-index.md
|
|
cases/jeecgboot-work-order/instructor-guide.md
|
|
cases/jeecgboot-work-order/learner-guide.md
|
|
cases/jeecgboot-work-order/prompts.md
|
|
cases/jeecgboot-work-order/source-map.md
|
|
cases/jeecgboot-work-order/worksheets.md
|
|
```
|
|
|
|
- [ ] **Step 2: Scan for placeholders**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "TODO|TBD|待补|your/path|foo|bar|unknown" cases/jeecgboot-work-order
|
|
```
|
|
|
|
Expected: no output.
|
|
|
|
- [ ] **Step 3: Check source path references**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
rg -n "../../../JeecgBoot|jeecg-boot|jeecgboot-vue3|docs/project-knowledge" cases/jeecgboot-work-order
|
|
```
|
|
|
|
Expected: source references exist in `source-map.md`, `prompts.md`, and guides.
|
|
|
|
- [ ] **Step 4: Check Git status**
|
|
|
|
Run:
|
|
|
|
```bash
|
|
git status --short
|
|
```
|
|
|
|
Expected: only new `docs/` and `cases/` from this work plus pre-existing unrelated changes.
|
|
|