# Prompt 模板库 ## 使用规则 复制模板前,先把本组实际上下文填入尖括号占位说明处。不要把模板原样丢给 TRAE。 每个 Prompt 都必须要求 TRAE 输出: ```text 事实依据 推断 建议 不确定点 下一步验证 ``` 通用约束: - 先找依据,再给结论。 - 不要直接改代码,除非我明确要求进入修改阶段。 - 项目事实必须标注文件路径、函数、接口、配置或文档来源。 - 业务规则必须标注为“待人工确认”,不能伪装成源码事实。 - 涉及权限、状态、审计、删除、看板的内容必须给出验收方式。 ## 项目理解 Prompt ```text 请基于以下 JeecgBoot 项目路径,帮我建立工单案例的项目地图。 上下文路径: - ../../../JeecgBoot/docs/project-knowledge/README.md - ../../../JeecgBoot/jeecg-boot/CLAUDE.md - ../../../JeecgBoot/jeecgboot-vue3/CLAUDE.md - ../../../JeecgBoot/jeecg-boot/pom.xml - ../../../JeecgBoot/jeecgboot-vue3/package.json 请输出: 1. 事实依据:按后端、前端、权限、配置、数据库分组列路径和作用。 2. 推断:根据这些路径推断工单模块如果二开,可能落在哪些层。 3. 建议:课堂应该优先阅读哪些文件。 4. 不确定点:哪些信息仅靠当前路径无法确认。 5. 下一步验证:还需要继续查哪些文件或接口。 约束: - 先找依据,再给结论。 - 不要直接改代码。 - 不要泛泛介绍 JeecgBoot。 ``` ## 源码定位 Prompt ```text 我正在做 JeecgBoot 工单案例,请帮我定位以下主题的源码依据: 主题: - 前端页面如何组织 - 前端 API 请求如何封装 - 动态路由和权限码如何进入前端 - 后端 Controller/Service/Mapper 常见结构 - 后端配置和数据库迁移在哪里 已知路径: - ../../../JeecgBoot/jeecgboot-vue3/src/main.ts - ../../../JeecgBoot/jeecgboot-vue3/src/router - ../../../JeecgBoot/jeecgboot-vue3/src/store/modules/permission.ts - ../../../JeecgBoot/jeecgboot-vue3/src/utils/http/axios - ../../../JeecgBoot/jeecg-boot/jeecg-module-system - ../../../JeecgBoot/docs/project-knowledge/generated/backend-endpoints.md - ../../../JeecgBoot/docs/project-knowledge/generated/frontend-routes.md 请输出一个源码依据表,列为: 主题 | 路径 | 证据内容 | 对工单案例的意义 | 不确定点 约束: - 事实必须来自路径。 - 不要直接改代码。 - 对不能确认的内容写“不确定点”。 ``` ## 需求拆解 Prompt ```text 请把“企业工单管理与研发效能看板”拆成适合 JeecgBoot 二开的需求说明。 业务目标: - 管理研发工单、缺陷和支持请求。 - 支持列表、详情、创建、编辑、指派、状态流转、评论、审计和看板。 角色: - 管理员 - 工单负责人 - 研发处理人 - 测试验证人 - 只读观察者 请输出: 1. 事实依据:当前 JeecgBoot 项目能支撑这类功能的源码或文档路径。 2. 用户故事:按角色拆分。 3. 字段清单:字段名、含义、类型、是否必填、字典需求。 4. 非目标范围:课堂不做哪些功能。 5. 验收标准:每个用户故事如何验收。 6. 不确定点:需要业务方确认的规则。 约束: - 先找依据,再给结论。 - 不要直接改代码。 - 权限和状态规则必须标注为待人工确认。 ``` ## 接口契约 Prompt ```text 请为 JeecgBoot 工单案例设计接口契约,不要写实现代码。 必须包含: - 工单分页列表 - 工单详情 - 新增工单 - 编辑工单 - 指派负责人 - 状态流转 - 查询审计日志 - 看板指标 请输出 Markdown 表格,列为: 接口名称 | 方法 | 路径建议 | 请求参数 | 响应字段 | 权限字符建议 | 成功场景 | 失败场景 | 验收方式 | 事实依据/推断 约束: - 路径建议可以是推断,但必须标注为推断。 - 事实依据必须引用 JeecgBoot 当前源码或 docs/project-knowledge。 - 不要直接改代码。 - 输出不确定点和下一步验证。 ``` ## RBAC 权限矩阵 Prompt ```text 请基于 JeecgBoot 工单案例设计 RBAC 权限矩阵。 角色: - 管理员 - 工单负责人 - 研发处理人 - 测试验证人 - 只读观察者 功能点: - 查看列表 - 查看详情 - 新建工单 - 编辑工单 - 指派负责人 - 状态流转 - 关闭工单 - 删除工单 - 查看审计日志 - 查看看板 - 导出数据 请输出: 1. 事实依据:JeecgBoot 权限、菜单、动态路由相关路径。 2. 权限矩阵:角色 x 功能点,允许、拒绝、条件允许。 3. 权限字符建议:例如 work:ticket:add,必须说明只是建议。 4. 页面级、按钮级、接口级控制方式。 5. 不确定点:必须人工确认的业务权限。 6. 验收方式:如何验证权限确实生效。 约束: - 先找依据,再给结论。 - 不要直接改代码。 - 不要让前端按钮隐藏替代后端接口权限。 ``` ## 权限落地检查 Prompt ```text 请检查以下工单权限设计是否适合 JeecgBoot 项目落地。 输入材料: - RBAC 权限矩阵:<粘贴矩阵> - 接口契约:<粘贴接口契约> - 源码依据:<粘贴 source-map 中相关路径> 请按以下维度 Review: 1. 事实依据:哪些结论能被 JeecgBoot 路径支撑。 2. 页面级权限是否明确。 3. 按钮级权限是否明确。 4. 接口级权限是否明确。 5. 数据范围是否明确。 6. 权限字符是否有命名规则。 7. 缺失项和风险。 8. 下一步验证。 约束: - 不要直接改代码。 - 所有建议必须配验收方式。 ``` ## 状态机设计 Prompt ```text 请为 JeecgBoot 工单案例设计状态流转规则。 候选状态: - 新建 - 处理中 - 待验证 - 已关闭 - 已驳回 候选动作: - 指派 - 开始处理 - 提交验证 - 验证通过 - 验证驳回 - 关闭 - 重新打开 请输出: 1. 事实依据:当前项目中可参考的状态、字典、业务模块路径。 2. 状态流转表:当前状态 | 动作 | 目标状态 | 允许角色 | 前置条件 | 后置动作。 3. 非法流转清单。 4. 接口设计建议。 5. 测试点。 6. 不确定点和下一步验证。 约束: - 先出状态表,不要直接写 if else。 - 不要直接改代码。 - 每条流转都要有验收方式。 ``` ## 审计日志 Prompt ```text 请为 JeecgBoot 工单案例设计审计日志方案。 关键操作: - 创建工单 - 编辑标题、描述、优先级、类型 - 指派负责人 - 状态流转 - 新增评论 - 删除或关闭 - 权限拒绝的重要操作 请输出: 1. 事实依据:JeecgBoot 当前日志、系统模块或项目知识库中可参考的路径。 2. 审计字段表:字段名 | 含义 | 类型 | 示例 | 是否必填。 3. 操作记录清单:操作 | 记录时机 | oldValue | newValue | actor | source。 4. 查询接口建议。 5. 展示方式建议。 6. 异常态和验收方式。 7. 不确定点。 约束: - 不要直接改代码。 - 字段前后值必须考虑敏感信息脱敏。 ``` ## 异常态 Prompt ```text 请基于 JeecgBoot 工单案例,列出必须处理的异常态和防御性逻辑。 范围: - 列表查询 - 详情查询 - 新增和编辑 - 指派 - 状态流转 - 删除或关闭 - 审计日志查询 - 看板查询 请输出表格: 场景 | 异常态 | 触发条件 | 前端表现 | 后端处理 | 用户提示 | 测试点 | 验收方式 约束: - 先列异常态,不要直接改代码。 - 权限不足、重复提交、非法状态、数据不存在、并发修改必须覆盖。 - 输出事实、推断、建议、不确定点、下一步验证。 ``` ## 看板指标 Prompt ```text 请为 JeecgBoot 工单案例设计研发效能看板指标。 指标方向: - 工单总数 - 未关闭工单数 - 平均关闭周期 - 按优先级分布 - 按类型分布 - 缺陷趋势 - 逾期工单数 - 人员处理负载 请输出: 1. 指标表:指标名 | 口径 | 维度 | 过滤条件 | 数据来源建议 | 图表形式 | 权限要求 | 异常态。 2. 接口契约建议。 3. 前端页面状态。 4. 验收方式。 5. 不确定点。 约束: - 不要只写页面样式。 - 每个指标必须可计算。 - 不要直接改代码。 ``` ## 修改计划 Prompt ```text 请基于以下材料,为 JeecgBoot 工单案例生成代码修改计划,但不要直接改代码。 输入材料: - 源码依据表:<粘贴> - 需求拆解表:<粘贴> - 接口契约表:<粘贴> - RBAC 权限矩阵:<粘贴> - 状态流转表:<粘贴> - 审计日志设计:<粘贴> - 异常态清单:<粘贴> 请输出: 1. 事实依据:涉及哪些已有路径。 2. 修改范围:后端、前端、配置、数据库、测试。 3. 分步计划:每一步改什么、为什么、怎么验收。 4. 风险点:权限、状态、审计、兼容性、数据迁移。 5. 测试计划:正常流、异常流、权限流、边界值。 6. 不确定点:必须人工确认后才能实施的内容。 约束: - 不要直接改代码。 - 后端计划必须提醒遵守 update-begin/update-end 修改痕迹规则。 - 前端计划必须提醒复用 defHttp、Pinia、动态路由和项目组件。 ``` ## Review Prompt ```text 请对以下 JeecgBoot 工单案例交付物做 Review。 输入材料: - 源码依据记录表:<粘贴> - 需求拆解表:<粘贴> - 接口契约表:<粘贴> - RBAC 权限矩阵:<粘贴> - 状态流转表:<粘贴> - 审计日志设计表:<粘贴> - 异常态清单:<粘贴> - 看板指标表:<粘贴> 请输出: 1. Review 结论:通过 / 有条件通过 / 不通过。 2. 事实依据是否充分。 3. 高风险问题:按严重程度排序。 4. 遗漏项:权限、状态、审计、异常态、看板、测试。 5. 不确定点:必须人工确认的业务规则。 6. 修复建议:每条建议都要有验收方式。 7. 下一步验证。 约束: - 不要只说“整体不错”。 - 不要直接改代码。 - 问题必须可定位、可验证、可行动。 ```