jira-epic
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseWhen to Use
适用场景
Use this skill when creating Jira epics for:
- Large features spanning multiple components
- New views/pages in the application
- Major refactoring initiatives
- Features requiring API + UI + SDK work
在为以下内容创建Jira Epic时使用此技能:
- 跨多个组件的大型功能
- 应用中的新视图/页面
- 重大重构计划
- 需要API + UI + SDK协作的功能
Epic Template
Epic模板
markdown
undefinedmarkdown
undefined{Epic Title}
{Epic标题}
Figma: {figma link if available}
Figma: {如有可用的Figma链接}
Feature Overview
功能概述
{2-3 paragraph description of what this feature does and why it's needed}
{2-3段描述,说明该功能的作用及必要性}
Requirements
需求
{Section 1: Major Functionality Area}
{第一部分:核心功能领域}
{Subsection}
{子部分}
- Requirement 1
- Requirement 2
- Requirement 3
- 需求1
- 需求2
- 需求3
{Another Subsection}
{另一子部分}
- Requirement 1
- Requirement 2
- 需求1
- 需求2
{Section 2: Another Major Area}
{第二部分:其他核心领域}
{Subsection}
{子部分}
- Requirement 1
- Requirement 2
- 需求1
- 需求2
Technical Considerations
技术考量
Performance
性能
- {Performance requirement 1}
- {Performance requirement 2}
- {性能需求1}
- {性能需求2}
Data Integration
数据集成
- {Data source}
- {Integration points}
- {数据源}
- {集成点}
UI Components
UI组件
- {Component 1}
- {Component 2}
- {组件1}
- {组件2}
Implementation Checklist
实施检查清单
- {Major deliverable 1}
- {Major deliverable 2}
- {Major deliverable 3}
- {核心交付项1}
- {核心交付项2}
- {核心交付项3}
Diagrams
图表
{Mermaid diagrams for architecture, flow, data model, etc.}
undefined{Mermaid架构图、流程图、数据模型图等}
undefinedEpic Title Conventions
Epic标题规范
Format:
[EPIC] Feature NameExamples:
[EPIC] Findings View[EPIC] Multi-tenant Support[EPIC] Compliance Dashboard Redesign[EPIC] GovCloud Support
格式:
[EPIC] 功能名称示例:
[EPIC] 结果视图[EPIC] 多租户支持[EPIC] 合规仪表板重设计[EPIC] GovCloud支持
Required Sections
必填章节
1. Feature Overview
1. 功能概述
Brief but complete description of:
- What the feature does
- Who uses it
- Why it's needed
简洁完整地描述:
- 功能作用
- 使用人群
- 必要性
2. Requirements
2. 需求
Organized by functional area:
- Group related requirements together
- Use clear headers and subheaders
- Be specific and testable
按功能领域整理:
- 相关需求分组
- 使用清晰的标题和子标题
- 内容具体且可测试
3. Technical Considerations
3. 技术考量
Always include:
- Performance: Large dataset handling, pagination, caching
- Data Integration: Data sources, APIs, relationships
- UI Components: Reusable components, design system usage
需包含以下内容:
- 性能:大数据集处理、分页、缓存
- 数据集成:数据源、API、关联关系
- UI组件:可复用组件、设计系统使用
4. Implementation Checklist
4. 实施检查清单
High-level deliverables that will become individual tasks:
- Each checkbox = potential Jira task
- Order by dependency (API before UI)
- Include testing milestones
将成为独立任务的高层级交付项:
- 每个复选框对应一个潜在Jira任务
- 按依赖关系排序(API优先于UI)
- 包含测试里程碑
Diagrams
图表
Use Mermaid for:
使用Mermaid创建以下图表:
Architecture Diagrams
架构图
mermaid
graph TB
UI[UI Components] --> API[API Endpoints]
API --> SDK[Prowler SDK]
SDK --> Cloud[Cloud Providers]mermaid
graph TB
UI[UI Components] --> API[API Endpoints]
API --> SDK[Prowler SDK]
SDK --> Cloud[Cloud Providers]Data Flow Diagrams
数据流图
mermaid
sequenceDiagram
User->>UI: Apply filters
UI->>API: GET /findings?filters
API->>DB: Query findings
DB-->>API: Results
API-->>UI: JSON response
UI-->>User: Render tablemermaid
sequenceDiagram
User->>UI: Apply filters
UI->>API: GET /findings?filters
API->>DB: Query findings
DB-->>API: Results
API-->>UI: JSON response
UI-->>User: Render tableState Diagrams
状态图
mermaid
stateDiagram-v2
[*] --> Pending
Pending --> InProgress: Start triage
InProgress --> Resolved: Mark resolved
InProgress --> Pending: Reset
Resolved --> [*]mermaid
stateDiagram-v2
[*] --> Pending
Pending --> InProgress: Start triage
InProgress --> Resolved: Mark resolved
InProgress --> Pending: Reset
Resolved --> [*]Entity Relationship Diagrams
实体关系图
mermaid
erDiagram
FINDING ||--o{ RESOURCE : affects
FINDING }|--|| CHECK : "belongs to"
RESOURCE }|--|| ACCOUNT : "belongs to"
ACCOUNT }|--|| PROVIDER : "belongs to"mermaid
erDiagram
FINDING ||--o{ RESOURCE : affects
FINDING }|--|| CHECK : "belongs to"
RESOURCE }|--|| ACCOUNT : "belongs to"
ACCOUNT }|--|| PROVIDER : "belongs to"Splitting Epic into Tasks
将Epic拆分为任务
After creating the epic, generate individual tasks using the skill:
jira-task创建Epic后,使用技能生成独立任务:
jira-taskTask Naming Pattern
任务命名规则
From epic , create:
[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)
以Epic 为例,创建以下任务:
[EPIC] 结果视图[FEATURE] 带分页的结果表格(UI)[FEATURE] 结果筛选器 - 提供商和账户(UI)[FEATURE] 结果详情面板 - 概述标签页(UI)[FEATURE] 结果详情面板 - 资源标签页(UI)[FEATURE] 结果批量操作 - 静音/抑制(API + UI)[FEATURE] 结果搜索功能(API + UI)
Task Dependencies
任务依赖
Always specify in each task:
markdown
undefined需在每个任务中明确指定:
markdown
undefinedRelated Tasks
相关任务
- Epic: [EPIC] Findings View
- Blocked by: [task if any]
- Blocks: [task if any]
undefined- Epic: [EPIC] 结果视图
- 被阻塞于:[如有依赖任务]
- 阻塞:[如有被阻塞任务]
undefinedFigma Integration
Figma集成
When Figma links are provided:
- Include main Figma link at top
- Reference specific frames in relevant sections
- Example:
https://www.figma.com/design/xxx?node-id=1830-44712&m=dev
当提供Figma链接时:
- 在顶部添加主Figma链接
- 在相关章节中引用特定框架
- 示例:
https://www.figma.com/design/xxx?node-id=1830-44712&m=dev
Output Format
输出格式
markdown
undefinedmarkdown
undefinedEpic: [EPIC] {Title}
Epic: [EPIC] {标题}
{Full epic content following template}
{遵循模板的完整Epic内容}
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?
undefined基于此Epic,创建以下任务:
| # | 标题 | 组件 | 被阻塞于 |
|---|---|---|---|
| 1 | [FEATURE] 任务名称 | API | - |
| 2 | [FEATURE] 任务名称 | UI | 任务1 |
| 3 | [FEATURE] 任务名称 | UI | 任务2 |
是否需要我生成完整的任务描述?
undefinedChecklist Before Submitting
提交前检查清单
- ✅ Title follows format
[EPIC] Feature Name - ✅ Feature Overview explains what/who/why
- ✅ Requirements are organized by functional area
- ✅ Technical Considerations cover performance, data, UI
- ✅ Implementation Checklist has high-level deliverables
- ✅ Diagrams included where helpful (Mermaid format)
- ✅ Figma links included if available
- ✅ Suggested tasks table provided at the end
- ✅ 标题遵循格式
[EPIC] 功能名称 - ✅ 功能概述解释了是什么/给谁用/为什么需要
- ✅ 需求按功能领域整理
- ✅ 技术考量涵盖性能、数据、UI
- ✅ 实施检查清单包含高层级交付项
- ✅ 按需添加图表(Mermaid格式)
- ✅ 如有可用则包含Figma链接
- ✅ 在末尾提供建议任务表格
Formatting Rules
格式规则
CRITICAL: All output MUST be in Markdown format, ready to paste into Jira.
- Use for epic title,
#for main sections,##for subsections### - Use for emphasis
**bold** - Use for checkboxes in Implementation Checklist
- [ ] - Use ``` for code blocks and Mermaid diagrams
- Use for file paths, commands, and code references
backticks - Use tables for Suggested Tasks section
- Use to separate epic from suggested tasks
---
重要提示: 所有输出必须为Markdown格式,可直接粘贴到Jira中。
- 使用作为Epic标题,
#作为主章节,##作为子章节### - 使用强调内容
**加粗** - 使用作为实施检查清单的复选框
- [ ] - 使用```包裹代码块和Mermaid图表
- 使用包裹文件路径、命令和代码引用
反引号 - 建议任务部分使用表格
- 使用分隔Epic和建议任务
---
Jira MCP Integration
Jira MCP集成
CRITICAL: When creating epics via MCP, use these exact parameters:
重要提示: 通过MCP创建Epic时,需使用以下精确参数:
Required Fields
必填字段
json
{
"project_key": "PROWLER",
"summary": "[EPIC] Feature name",
"issue_type": "Epic",
"additional_fields": {
"customfield_10359": {"value": "UI"}
}
}json
{
"project_key": "PROWLER",
"summary": "[EPIC] Feature name",
"issue_type": "Epic",
"additional_fields": {
"customfield_10359": {"value": "UI"}
}
}Team Field (REQUIRED)
团队字段(必填)
The (Team) field is REQUIRED. Options:
customfield_10359- - Frontend epics
"UI" - - Backend epics
"API" - - Prowler SDK epics
"SDK"
customfield_10359- - 前端Epic
"UI" - - 后端Epic
"API" - - Prowler SDK Epic
"SDK"
Work Item Description Field
工作项描述字段
IMPORTANT: The project uses (Work Item Description) instead of the standard field for display in the UI.
customfield_10363descriptionCRITICAL: Use Jira Wiki markup, NOT Markdown:
- instead of
h2.## - for bold instead of
*text***text** - for bullets (same)
* item - for nested bullets
** subitem
After creating the epic, update the description with:
json
{
"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}"
}注意: 项目使用(工作项描述)字段而非标准字段在UI中展示内容。
customfield_10363description重要提示: 使用Jira Wiki标记语言,而非Markdown:
- 使用替代
h2.## - 使用替代
*文本*实现加粗**文本** - 使用作为项目符号(与Markdown一致)
* 项 - 使用作为嵌套项目符号
** 子项
创建Epic后,使用以下内容更新描述:
json
{
"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}"
}Linking Tasks to Epic
将任务关联到Epic
When creating child tasks, use the epic key as parent:
json
{
"additional_fields": {
"parent": "PROWLER-XXX"
}
}创建子任务时,使用Epic的键作为父项:
json
{
"additional_fields": {
"parent": "PROWLER-XXX"
}
}Workflow Transitions
工作流转换
Backlog (10037) → To Do (14) → In Progress (11) → Done (21)
→ Blocked (10)Backlog (10037) → To Do (14) → In Progress (11) → Done (21)
→ Blocked (10)MCP Commands Sequence
MCP命令序列
- Create epic:
mcp__mcp-atlassian__jira_create_issue (issue_type: "Epic")- Update Work Item Description:
mcp__mcp-atlassian__jira_update_issue with customfield_10363- Create child tasks:
mcp__mcp-atlassian__jira_create_issue with parent: EPIC-KEY- Assign and transition:
mcp__mcp-atlassian__jira_update_issue (assignee)
mcp__mcp-atlassian__jira_transition_issue (status)- 创建Epic:
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)Keywords
关键词
jira, epic, feature, initiative, prowler, large feature
jira, epic, feature, initiative, prowler, large feature