-
Notifications
You must be signed in to change notification settings - Fork 90
docs(epic-workflow): add epic delivery guide on how to manage epics #19551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jrainville
wants to merge
2
commits into
docs/release-process-guide
Choose a base branch
from
docs/design-dev-workflow-guide
base: docs/release-process-guide
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+91
−1
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Cross-Team Epic Delivery Workflow | ||
|
|
||
| This guide documents the optimal steps to create and work on Feature Epics in a collaborative way. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Cross-Team Epic Delivery Workflow](#cross-team-epic-delivery-workflow) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [1. Epic Creation (Product / Dev / Design)](#1-epic-creation-product--dev--design) | ||
| - [2. Design Exploration Phase](#2-design-exploration-phase) | ||
| - [3. Final Design Approval \& Handoff](#3-final-design-approval--handoff) | ||
| - [4. Development Planning](#4-development-planning) | ||
| - [5. Design QA (Post-Implementation Review)](#5-design-qa-post-implementation-review) | ||
| - [6. Epic Completion](#6-epic-completion) | ||
| - [TLDR Summary Workflow (High-Level)](#tldr-summary-workflow-high-level) | ||
|
|
||
| ## 1. Epic Creation (Product / Dev / Design) | ||
|
|
||
| * An **EPIC** is created for any new feature or major improvement (by product, dev or design teams). | ||
| * The EPIC includes: | ||
| * Feature requirements | ||
| * High-level scope | ||
| * Known constraints or assumptions | ||
| * The epic is assigned to the **Design Team** with the label **<code>needs-design</code>**. | ||
|
|
||
|
|
||
| ## 2. Design Exploration Phase | ||
|
|
||
| * The designer changes the epic status to **“In Progress”** once exploration begins. | ||
| * The designer starts drafting early concepts / prototypes. | ||
| * The designer is responsible for **pinging the Dev owner** early to initiate collaboration. | ||
| * Multiple review iterations may happen with: | ||
| * Dev / Product / (Optionally) other stakeholders (eg QA engineers) | ||
| * Syncs may be: | ||
| * **Async** (chat / comments) / **Sync calls**, as needed | ||
| * Communication should be **frequent**, potentially more than once per week for complex features. | ||
|
|
||
|
|
||
| ## 3. Final Design Approval & Handoff | ||
|
|
||
| * Last meeting to present the final design | ||
| * Once iterated and aligned, the final design direction is agreed by: | ||
| * Design / Product / Dev | ||
| * The designer prepares and delivers the **Figma handoff package**. | ||
| * The designer **removes the <code>needs-design</code> label** from the epic. | ||
| * The designer **pings the Dev team** (in the same epic) to indicate the feature is ready for implementation. | ||
|
|
||
|
|
||
| ## 4. Development Planning | ||
|
|
||
| * The Dev owner reviews the final design. | ||
| * The Dev owner breaks down the epic into **small, actionable subtasks**. | ||
| * Subtasks include: | ||
| * UI components / Interactions / Edge states | ||
| * Integration work | ||
| * Non-visual logic affected by UI | ||
| * The Dev owner assigns subtasks within the team (if needed) and starts implementation. | ||
| * It should have acceptance criteria | ||
|
|
||
|
|
||
| ## 5. Design QA (Post-Implementation Review) | ||
|
|
||
| * Once the implementation is complete, **Dev notifies Design**. | ||
| * A **Design QA task** is created within the epic for tracking. | ||
|
||
| * Designer reviews the built feature to ensure: | ||
| * Visual fidelity | ||
| * Correct interactions | ||
| * Proper responsive handling | ||
| * Consistency with the agreed design | ||
| * Any necessary follow-ups are captured as subtasks and addressed by Dev. | ||
|
|
||
|
|
||
| ## 6. Epic Completion | ||
|
|
||
| * When: | ||
| * All dev subtasks are done | ||
| * Design QA is approved | ||
| * Product is aligned | ||
|
|
||
| * The epic is marked as **Completed** and closed. | ||
|
|
||
|
|
||
| ## TLDR Summary Workflow (High-Level) | ||
|
|
||
| 1. <strong>Epic created -> assigned to Design with <code>needs-design</code></strong> | ||
| 2. <strong>Design exploration -> prototypes -> early dev syncs</strong> | ||
| 3. <strong>Final design agreed -> Figma delivered -> <code>needs-design</code> label removed -> dev notified</strong> | ||
| 4. <strong>Dev decomposes work -> implements subtasks</strong> | ||
| 5. <strong>Design QA -> fixes -> approval</strong> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could also add here what we discussed about creating a task to include this new feature in the automation flow.