Skip to content
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.

Sign up for GitHub

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

Update recording-work-item-and-tips.mdx #72

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update recording-work-item-and-tips.mdx #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f467632
Update recording-work-item-and-tips.mdx
tiagov8 Jan 23, 2025
d96a261
Merge branch 'main' into tiagov8-patch-1
tiagov8 Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions content/docs/YakShaver/recording-work-item-and-tips.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,34 +31,42 @@ Got YakShaver setup with Teams? Here's how you can create a recording to be proc
![](/YakShaver/yakshaver-is-done.png)\
**Figure: YakShaver task confirmation on Teams**

8. ✅ Done - You will receive one of the 3 email types (based on the project):
8. ✅ Done - You will receive one of the 3 email types (based on the project): \

a. The email task itself
b. GitHub email notification with a link to the Issue
c. Azure DevOps email notification with a link to the PBI
- A. The email task itself
- B. GitHub email notification with a link to the Issue
- C. Azure DevOps email notification with a link to the PBI

![](/YakShaver/yakshaver-github-email.png)\
**Figure: YakShaver task confirmation on email (GitHub example)**

***

### Tips to help YakShaver create the perfect work item
## Tips to help YakShaver create the perfect work item

* **State your intent** - Begin the recording with the purpose. E.g.:
### State your intent

Begin the recording with the purpose.

*“Send an email task to...”*
*“I have a new feature request for SugarLearning...”*
> *“Send an email task to...”*
> *“I have a new feature request for SugarLearning...”*

### Detail bug reports

* **Detail bug reports** - For bugs, mention reproduction steps and expected behaviour. E.g.:
For bugs, mention reproduction steps and expected behaviour.

*“First do this, then do this, then this error occurs, but I expect it to do this”*
> *“First do this, then do this, then this error occurs, but I expect it to do this”*

**Note:** Have a look at [Tip #1 - Draft your bug with enough details](https://www.ssw.com.au/rules/report-bugs-and-suggestions/#tip-1-draft-your-bug-with-enough-details)
**Note:** Have a look at [Tip #1 - Draft your bug with enough details](https://www.ssw.com.au/rules/report-bugs-and-suggestions/#tip-1-draft-your-bug-with-enough-details)

### Mention additional team members

So you include others who are not in the meeting.

* **Mention additional team members** to include others who are not in the meeting. E.g:
> *“...Cc Adam and Uly”*

*“...Cc Adam and Uly”*
**Note:** Creating a PBI or bug report will automatically CC the Product Owner and Tech Lead.

**Note:** Creating a PBI or bug report will automatically CC the Product Owner and Tech Lead.
### Move PBIs

* **Move PBIs** - If the PBI was created in the wrong project, use the “Move PBI” option to relocate it to another project.
If the PBI was created in the wrong project, use the “Move PBI” option to relocate it to another project.