Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Current »

Example Mapping primer

For a quick introduction to Example Mapping see this excellent article - Introducing Example Mapping written by the creator of the technique


To switch into Example Mapping mode use the buttons in the footer section of the editor panel highlighted below

image-20241011-114650.png

* Note that in the Data Center version of the app the mode buttons are located on the left and the Save & Cancel buttons on the right

Slide Out Panel for New Notes

Use the toolbar button highlighted below to show or hide the panel which contains new note stacks. Here you can capture description of new Rules, Scenarios etc. and then drag the notes to the right.

image-20241011-090303.png

Once the notes have been dragged to the right they become part of the Feature file and are persisted when you press the Save button.

image-20241011-091307.png

Always show new Story notes
By default new notes stack for User Stories gets hidden once you have dragged over at least one user story note to the right. It can however be made always visible via the editor option menu highlighted below.

image-20241011-094422.png

This can be useful when you need to split the current user story into further separate stories. You can temporarily capture the newly split story onto another User Story note card in the current Feature before creating a new Jira issue and moving it there under its own Feature panel.

Slide out from the right

The new notes panel can be configured to slide out from the right rather than from the left using the menu option highlighted below

image-20241011-113806.png

Drag & Drop Notes

Place the mouse cursor at the bottom of any note so that the note’s drag handle becomes visible. Then click and hold the left mouse button to “grab” the note. Move it with the mouse to the desired location and then release the mouse button to drop the note.

image-20241011-121159.png

The locations where a particular note can be dropped is colour highlighted when the note is dragged over it. The note will be auto aligned after dropping so you don’t need to be precise with positioning. Where exactly each type of note can be dropped is explained in the following sections.

Dropping User Story Notes

User Story notes are top level elements and can be dropped onto an empty space or next to other User Story notes dropped earlier.

image-20241011-121841.png

More than one User Story note

At times you might discover another User Story not previously known as part of your team’s Example Mapping discussions. When this happens it is useful to be able to capture it quickly under the same feature so that it doesn’t get lost and then later after the meeting move it out into its own Jira issue and Feature panel.

image-20241011-122953.png

Dropping Rule Notes

Rule notes can be dropped onto a User Story note that doesn’t yet have any Rule notes

image-20241011-125314.png

Or next to other Rule notes dropped earlier

image-20241011-124356.png

Or onto a User Story note that is currently folded (see Fold Note Groups)

image-20241011-124623.png

Dropping Scenario Notes

Scenario notes can be dropped onto a Rule note that doesn’t yet have any Scenario notes

image-20241011-125456.png

Or next to other Scenario notes dropped earlier

image-20241011-130633.png

Or onto a Rule note that is currently folded

image-20241011-143046.png

Story scenarios
Cucumber syntax supports having Scenarios without a preceding Rule, so you can also drop a Scenario note directly onto a Story note

image-20241011-143845.png

See below for difference between a Scenario that belongs to a User Story vs a Scenario that belongs to a Rule

image-20241011-144728.png

Dropping Question Notes

Semantically questions can belong to User Stories, Rules or Scenarios, so you can drop them accordingly

image-20241011-150034.png

You can also drop a Question note onto Story, Rule or Scenario note that is currently folded

image-20241011-150249.png

Dropping Step Notes

Unhide Step notes

Step notes are hidden by default, but they can be made visible by unchecking the editor menu option shown below

image-20241011-150730.png

Step notes can be dropped onto folded Scenario notes or next to other Scenario steps or question notes like shown below

image-20241011-151007.png

Steps & questions mixed

Step and question notes that belong to a Scenario can be arranged in any order like shown in example below

image-20241011-151608.png

Note Keywords

Notes can optionally be configured to show the leading keywords that are there when viewing the corresponding lines for the note in the Gherkin Text Editor mode. These leading keywords cannot be deleted when editing the note’s text.

User Story Note Keywords

Use the preferences menu option highlighted below to show / hide the 'Feature' keyword.

image-20241012-101312.png

The common user story keywords 'As a’, ‘I want to’ and ‘So that’ get added automatically to new User Story notes but can be changed or deleted if required.

Rule Note Keyword

Use the preferences menu option highlighted below to show / hide the 'Rule' keyword.

image-20241012-103337.png

Scenario Note Keyword

Use the preferences menu option highlighted below to show / hide the Scenario Note keyword.

image-20241012-103657.png

Change Scenario keyword

Gherkin syntax supports one of: Scenario, Example, Scenario Outline and Scenario Template as leading keywords for a scenario. You can quickly change between these on a Scenario Note by hovering the mouse over the keyword and then clicking the left mouse button while holding the 'Alt' key. Then pick a different keyword from the drop down menu as shown below.

image-20241012-104007.png

Question Note Keywords

Use the preferences menu option highlighted below to show / hide the 'Q' keyword.

image-20241012-113856.png

The ‘A:' keyword used as a prefix before the answer to the note’s question is automatically added to the Question Note when ‘show keyword’ option is turned on, but can be deleted or added as required.

Note that if there is some text entered after the ‘A:' keyword the question is considered answered, see more information related to this in Capturing Questions & Answers.

Step Note Keywords

Use the preferences menu option highlighted below to show / hide the Step Note keyword.

image-20241012-114834.png

Change Step keyword

Gherkin syntax supports one of: Given, When, Then, And or But as leading keywords for a step. You can quickly change between these on a Scenario Note by hovering the mouse over the keyword and then clicking the left mouse button while holding the 'Alt' key. Then pick a different keyword from the drop down menu as shown below.

image-20241012-115132.png

Note that if a Step Note has keyword ‘And' or ‘But’ and it is moved to be the first step of a Scenario then the keyword will change to one of ‘Given’, ‘When’ or ‘Then’ since ‘And’ and 'But’ cannot be the first Step keywords of a Scenario.

Note Groups

Semantically related notes are grouped together for selection, copying and drag & drop operations. Ensuring that the preferences menu option highlighted below is checked will show a border around note groups.

image-20241011-153520.png

User Story Group

Click on the drag handle of a Story Note to see an outline border around all Scenario, Rule and Question notes that semantically belong to the selected User Story

image-20241011-155059.png

Rule Group

Click on the drag handle of a Rule Note to see an outline border around all Scenario and Question notes that semantically belong to the selected Rule

image-20241011-155223.png

Scenario Group

Click on the drag handle of a Scenario Note to see an outline border around all Step and Question notes that semantically belong to the selected Scenario

image-20241011-155502.png

Copy & Paste

Copying and pasting notes is performed intuitively using the traditional “Ctrl+C” & “Ctrl+V” keyboard shortcuts respectively (“Command+C” & “Command+V” on MacOS).

Copy and Paste Single Notes

To copy a single note simply select it and press “Ctrl+C”

image-20241011-161942.png

Then select the note after which you would like to paste the copied note and press “Ctrl+V“

image-20241011-162203.png

Copy & Paste Note Groups

You can copy all of the notes under Story, Rule or Scenario groups together in one operation. Simply select the group and press “Ctrl+C”

image-20241011-163238.png

Select the note after which you’d like to paste the copied note group and press “Ctrl+V” to paste

image-20241011-163526.png

Copy & Paste Between Jira Issues

The contents of copied notes is stored in the standard clipboard, which means you can copy and paste notes and note groups between Features of different Jira issues.

image-20241011-165132.png
image-20241002-172336.pngimage-20241002-172350.png
image-20241011-165452.png

Copy & Paste Into External Editors

The content of a single note or a note group is copied as plain text, which means you can paste it into external editors, e.g. IDEs, notepads, etc.

image-20241011-165758.png
image-20241002-172336.pngimage-20241002-172350.png
image-20241011-170119.png

Fold Note Groups

It is often easier to navigate the feature and to perform drag & drop operations by first folding note groups. This is particularly useful in Features with many notes.

To fold a note group, simply select it and press either “Alt+Enter“ keyboard shortcut or hold the “Alt“ key while clicking the note’s drag handle with the left mouse button.

image-20241011-171715.png

The folded summary is shown to the right of the folded note. It provides a quick visual indication of how many notes have been folded. Hovering over it with the mouse will show a tooltip with the number of individual notes or note groups that have been folded. Clicking on the folded summary will unfold the note group.

Fold User Stories

Folding User Story note group is useful when you want to quickly capture a newly discovered User Story under the same Feature during team discussions.

image-20241011-173245.png

Fold Rules

Folding Rule note groups can be useful whenever you just want to quickly review the acceptance criteria for a User Story (note that Rules in a Cucumber Feature file essentially are the acceptance criteria), without going into the details of the examples.

image-20241011-204939.png

Fold all rules
Click on the toolbar button highlighted below while holding the ‘Alt’ key in order to fold all of the Rules in one operation

image-20241011-210041.png

Click on the chevron double-down button next to it while holding the ‘Alt’ key to unfold all of the Rules

Fold Scenarios

Folding Scenario note groups can be useful when you don’t want to see the details of each of the examples especially when you are working also with the Step notes, as is the case with Feature Mapping.

image-20241011-210658.png

Fold all scenarios
Click on the toolbar button highlighted below in order to fold all of the Scenarios in one operation

image-20241011-211038.png

Click on the chevron double-down button next to it to unfold all of the Scenarios

Fold on Page Load

You can configure the Feature panel to have User Story, Rule or Scenario note groups folded every time the issue page loads. This can be useful if you wish to be presented with less information initially and then click to unfold only when you want to see the details.

This can be configured via the preferences menu option highlighted below.

image-20241011-212032.png

* Note that the “Feature” fold option shown in the screenshot above corresponds to folding the User Story note groups - since the user story text is placed at the Feature cucumber keyword when viewed as a plain text file.

Folding is Linked to Gherkin Text Editor Mode

Folding can be done either via Example Mapping mode or via the Gherkin Text Editor mode. The folded ranges are “linked“ between the two modes - meaning that if you fold a section of lines in Gherkin Text Editor then the corresponding note groups in Example Mapping will get folded also. This can be better seen when viewing the two modes in a side-by-side view, like shown below.

image-20241012-094253.png

Selected Scenario Note Group above corresponds to line number 9 in the Gherkin Text Editor panel on the right which has been folded.

Feature Mapping View

Feature Mapping primer

For an introduction to Feature Mapping see this excellent article - “Feature Mapping – a lightweight requirements discovery practice for agile teams” written by the author of “BDD in Action

Feature Mapping is another technique used to facilitate collaborative requirements discovery sessions. It differs from Example Mapping in that it incorporates the use of one additional card category to capture the Steps of an example/scenario, and it uses horizontal alignment (from left to right) for Rule and Scenario elements.

To switch to Feature Mapping view at any time click on the preferences menu option highlighted below.

image-20241012-151512.png

To make the outcome type steps (i.e. those with the Then keyword) stand out more you can assign a different colour to these notes using the preferences menu option highlighted below.

image-20241012-152147.png

Unhide Steps
Step Notes are hidden by default. To make them visible uncheck the preferences menu option highlighted below.

image-20241012-151029.png

Customize Look & Feel

The customizations explained in the following sections apply on per user basis, that is if you change any of the preferences mentioned it will apply to you only and others will see the Feature according to their preferences.

Size & Shape of Notes

Each of the note types can be configured to be of size: Small, Medium or Large and shape: Square or Rectangle.

Additionally Story and Step Notes can be of Extra Large size.

image-20241012-162020.png

Start with large and transition to small

When you first capture a User Story it might not be very obvious what are the rules and/or examples that will go into respective notes under this user story. So you might want to capture all the information that you know at the time about the user story in a free form text on an Extra Large User Story Note without worrying what is a Rule or what is a Scenario exactly etc.

image-20241012-163253.png

Then later when you have more information and are discussing the User Story during your team’s Example Mapping sessions, you can structure the information more into Rules, Scenarios, Questions etc. and make the User Story Note itself smaller.

image-20241012-163557.png


Note Colours

You can change the preferred colour used for different note types, see example below showing where this can done for a Story Note. The colour shades available for each note type are close to the colours originally suggested by the authors of the Example Mapping and Feature Mapping techniques.

image-20241015-184750.png

Note Border Outline

You can optionally show/hide a border around individual Notes or Note Groups using the preferences menu options highlighted below.

image-20241012-164542.png

You can also change border colour.

image-20241012-164613.png

Note Spacing

Use the preferences menu option highlighted below to change the note spacing.

image-20241012-180322.png

Wide

image-20241012-180436.png

Normal

image-20241012-180719.png

Compact

image-20241012-180539.png

Tight

image-20241012-180638.png

Drag Handle

Use the preferences menu option highlighted below to configure options for note drag handle.

image-20241012-180958.png

Top placement

image-20241012-181107.png

Bar shape

image-20241012-181149.png

Diamond shape

image-20241012-181221.png

None

The note remains draggable by the bottom portion even though there is no drag handle symbol

image-20241012-181310.png

Different colour and glow effect

image-20241012-181443.png

Line Numbers

Use the preferences menu option highlighted below to show line numbers in each of the note’s gutter

image-20241012-182612.png

The line numbers correspond to where the note’s content is located in the overall Feature file. This can be better seen when viewing the two modes side-by-side.

image-20241012-182852.png

Linked Selection & Scrolling

When the preferences menu option highlighted below is selected and the editor is shown in a side-by-side view then whenever you select a note in the left pane the editor on the right will automatically scroll to and highlight the lines where the note’s content is located. Automatic selection and scrolling works in the other direction also.

image-20241012-183205.png

This can be useful when you want to find where exactly is a particular note’s content located in what could be a longer Feature file.

image-20241012-183836.png

Keyboard Shortcuts

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.