关于 jira-epic
帮助团队编写 Jira Epic 的技能,提供结构模板、需求与技术考量清单,以及拆分任务和绘制 Mermaid 图的指导。内容还包含 Prowler Jira MCP 的创建与更新参数流程。
主要功能
- 01按模板组织 Epic 内容
- 02整理需求和技术考量
- 03用 Mermaid 描述架构与流程
- 04规划子任务及依赖关系
- 05提供 Prowler Jira MCP 操作参数
适用场景
- 01为跨组件功能创建 Epic
- 02把 Epic 拆分为有依赖关系的任务
- 03在 Jira MCP 中创建和更新 Prowler Epic
MCP 相关
说明了通过 Jira MCP 创建和更新 Epic、创建子任务、分配负责人及转换状态的操作流程,并给出 Prowler 项目的相关参数。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ gentleman-programming/ gentleman-skills --skill jira-epic安装后在 Claude Code 中输入/jira-epic确认已加载。
详细介绍
适用场景
在以下情况下使用此技能创建 Jira Epic:
- 跨多个组件的大型功能
- 应用中的新视图/页面
- 重大重构计划
- 需要 API + UI + SDK 协作的功能
Epic 模板
# {Epic Title}
**Figma:** {figma link if available}
## Feature Overview
{2-3 paragraph description of what this feature does and why it's needed}
## Requirements
### {Section 1: Major Functionality Area}
#### {Subsection}
- Requirement 1
- Requirement 2
- Requirement 3
#### {Another Subsection}
- Requirement 1
- Requirement 2
### {Section 2: Another Major Area}
#### {Subsection}
- Requirement 1
- Requirement 2
## Technical Considerations
### Performance
- {Performance requirement 1}
- {Performance requirement 2}
### Data Integration
- {Data source}
- {Integration points}
### UI Components
- {Component 1}
- {Component 2}
## Implementation Checklist
- [ ] {Major deliverable 1}
- [ ] {Major deliverable 2}
- [ ] {Major deliverable 3}
## Diagrams
{Mermaid diagrams for architecture, flow, data model, etc.}
Epic 标题规范
格式:[EPIC] Feature Name
示例:
[EPIC] Findings View[EPIC] Multi-tenant Support[EPIC] Compliance Dashboard Redesign[EPIC] GovCloud Support
必需章节
1. 功能概述
简明但完整地描述:
- 功能的作用
- 使用者
- 所需原因
2. 需求
按功能领域组织:
- 将相关需求归为一组
- 使用清晰的标题和副标题
- 内容应具体且可测试
3. 技术注意事项
始终包括:
- 性能:大型数据集处理、分页、缓存
- 数据集成:数据源、API、关系
- UI 组件:可复用组件、设计系统的使用
4. 实施检查清单
将成为独立任务的高层级交付项:
- 每个复选框 = 潜在的 Jira 任务
- 按依赖关系排序(API 在 UI 之前)
- 包含测试里程碑
图表
使用 Mermaid 绘制:
架构图
graph TB
UI[UI Components] --> API[API Endpoints]
API --> SDK[Prowler SDK]
SDK --> Cloud[Cloud Providers]
数据流图
sequenceDiagram
User->>UI: Apply filters
UI->>API: GET /findings?filters
API->>DB: Query findings
DB-->>API: Results
API-->>UI: JSON response
UI-->>User: Render table
状态图
stateDiagram-v2
[*] --> Pending
Pending --> InProgress: Start triage
InProgress --> Resolved: Mark resolved
InProgress --> Pending: Reset
Resolved --> [*]
实体关系图
erDiagram
FINDING ||--o{ RESOURCE : affects
FINDING }|--|| CHECK : "belongs to"
RESOURCE }|--|| ACCOUNT : "belongs to"
ACCOUNT }|--|| PROVIDER : "belongs to"
将 Epic 拆分为任务
创建 Epic 后,使用 jira-task 技能生成独立任务:
任务命名模式
对于 Epic [EPIC] Findings View,创建:
[FEATURE] Findings table with pagination (UI)[FEATURE] Findings filters - provider and account (UI)[FEATURE] Findings detail panel - Overview tab (UI)[FEATURE] Findings detail panel - Resources tab (UI)[FEATURE] Findings bulk actions - mute/suppress (API + UI)[FEATURE] Findings search functionality (API + UI)
任务依赖关系
在每个任务中始终明确说明:
## Related Tasks
- Epic: [EPIC] Findings View
- Blocked by: [task if any]
- Blocks: [task if any]
Figma 集成
提供 Figma 链接时:
- 在顶部包含主要 Figma 链接
- 在相关章节中引用具体画板
- 示例:
https://www.figma.com/design/xxx?node-id=1830-44712&m=dev
输出格式
## Epic: [EPIC] {Title}
{Full epic content following template}
---
## Suggested Tasks
Based on this epic, create the following tasks:
| # | Title | Component | Blocked By |
|---|-------|-----------|------------|
| 1 | [FEATURE] Task name | API | - |
| 2 | [FEATURE] Task name | UI | Task 1 |
| 3 | [FEATURE] Task name | UI | Task 2 |
Would you like me to generate the full task descriptions?
提交前检查清单
- ✅ 标题遵循
[EPIC] Feature Name格式 - ✅ 功能概述说明了做什么、面向谁以及原因
- ✅ 需求按功能领域组织
- ✅ 技术注意事项涵盖性能、数据和 UI
- ✅ 实施检查清单包含高层级交付项
- ✅ 在有帮助时加入图表(Mermaid 格式)
- ✅ 如有 Figma 链接,则一并提供
- ✅ 末尾附上建议任务表
格式规则
**重要:**所有输出都必须采用 Markdown 格式,可直接粘贴到 Jira。
- 使用
#作为 Epic 标题,使用##作为主要章节,使用###作为子章节 - 使用
**粗体**突出重点 - 在实施检查清单中使用
- [ ]复选框 - 使用 ``` 编写代码块和 Mermaid 图表
- 使用
反引号标记文件路径、命令和代码引用 - 在建议任务章节中使用表格
- 使用
---分隔 Epic 和建议任务
Jira MCP 集成
**重要:**通过 MCP 创建 Epic 时,必须使用以下确切参数:
必填字段
{
"project_key": "PROWLER",
"summary": "[EPIC] Feature name",
"issue_type": "Epic",
"additional_fields": {
"customfield_10359": {"value": "UI"}
}
}
团队字段(必填)
customfield_10359(Team)字段为必填项。可选值:
"UI"- 前端 Epic"API"- 后端 Epic"SDK"- Prowler SDK Epic
工作项描述字段
**重要:**项目使用 customfield_10363(Work Item Description)字段,而不是标准的 description 字段来在 UI 中显示内容。
**重要:**使用 Jira Wiki 标记语言,而非 Markdown:
- 使用
h2.代替## - 使用
*text*代替**text**表示粗体 - 使用
* item表示项目符号(相同) - 使用
** subitem表示嵌套项目符号
创建 Epic 后,使用以下内容更新描述:
{
"customfield_10363": "h2. Feature Overview\n\n{overview}\n\nh2. Requirements\n\n*{Section 1}*\n* {requirement 1}\n* {requirement 2}\n\n*{Section 2}*\n* {requirement 1}\n* {requirement 2}\n\nh2. Technical Considerations\n\n*Performance:*\n* {consideration 1}\n\n*Data Integration:*\n* {consideration 2}\n\nh2. Implementation Checklist\n\n* [ ] {deliverable 1}\n* [ ] {deliverable 2}\n* [ ] {deliverable 3}"
}
将任务关联到 Epic
创建子任务时,将 Epic 键用作父项:
{
"additional_fields": {
"parent": "PROWLER-XXX"
}
}
工作流转换
Backlog (10037) → To Do (14) → In Progress (11) → Done (21)
→ Blocked (10)
MCP 命令序列
- 创建史诗:
mcp__mcp-atlassian__jira_create_issue (issue_type: "Epic")
- 更新工作项描述:
mcp__mcp-atlassian__jira_update_issue with customfield_10363
- 创建子任务:
mcp__mcp-atlassian__jira_create_issue with parent: EPIC-KEY
- 分配并转换状态:
mcp__mcp-atlassian__jira_update_issue (assignee)
mcp__mcp-atlassian__jira_transition_issue (status)
关键词
jira、史诗、功能、计划、prowler、大型功能
评论
支持 Markdown