Requirements Clarity Map Documentation
Page tree
Skip to end of metadata
Go to start of metadata

Step-by-step guide

How to use and enable visual graph of requirements

Adding Requirement

To add requirement use "..." next to Create button, there after find "Product Requirement for Clarity Map

On this page:

Specifying properties

After confirming page creation you get confluence page that is done based on template inherited from standard confluence requirement blueprint

Properties relevant for Requirements Clarity map

Property nameDescriptionFormat, possible values
Short nameA title of the node for Clarity Map GraphChar : 15
DescriptionLong description of requirementText
Epiclink to Jira issue, presumably epic
ClarityHow clear is requirement. Defines fill color on Clarity Map Graph
  • UNKNOWN - requirement is terra incognita, you have no clue what is this. (fill color - black)
  • UNCERTAIN - you have some understanding of what is this, there are some areas that needs investigation, but general understanding is present (fill color - grey)
  • CLEAR - you understand fully what needs to be done, how that can be measured and how implementation can be checked. Requirement is ready to be assigned for development team with confidence of delivery (fill color - white)
SizeHow big is requirement. Defines size of the node on Clarity Map Graph. T-shirt size based qualification of size of requirement
  • XS - the smallest
  • S
  • M
  • L
  • XL - the largest
Question and AnswersOpen questions and answers for given requirementText


Enabling Requirements Clarity Map for existing requirements

Goto Space Tools > Add-ons

Select space and root element of requirement hierarchy > Add Properties

Adding Requirement Graph

You go with "+" sign on control button bar and then " ...  Other macros", then select Requirement Clarity Map

Provide 

ParameterDescription
Space Key Confluence key of the space where your requirements pages are located
Page TitleRoot of the tree where you want macros to start processing
  • Show/ hide graph UI hints
Whether or not you want to enable hints on the map usage

Insert adds a graph to your confluence page

What you can see and what you can do with a graph

Size 

Clarity 

How clear is a requirement is defined by one of three choices

  • UNKNOWN - team doesn't understand what risks are there, what effort is required for this to be implemented
  • UNCERTAIN - team has some understanding of what this requirements is about. There are some unclear items that needs to be researched or investigated
  • CLEAR - team understands complexity of requirement, understands implementation steps, acceptance criteria are defined


Status

Status of corresponding requirement is determined by status of associated Jira epic. In case no epic is yet created - status is NULL. On graph you can easily determine that by color of the bezel

StatusDefines status of this requirement. As soon as there is associated epic in Jira - Status is determined by status category of linked issue, before that - status is not defined
  • UNDEFINED
  • OPEN
  • IN PROGRESS
  • DONE


Useful hint

Requirement Clarity Map macro needs Application Link between Confluence and Jira to get statuses. To make it work you have to authenticate yourself on Jira side.
The easiest way to do it is to add default “Jira” macro on a page and perform the authentication.

Hierarchy

Ray diagram represent hierarchical structure of all requirements underneath provided root element. In sample case "Family"

+ / - signs are options to expand / collapse corresponding node

Properties

Selecting a node - opens property panel.

Following values are available for inline editing

  • Short name
  • Clarity
  • Size
  • Description
  • Questions and Answers


Timeline snapshots 

The possibility to compare current condition of the graph to saved versions was added.

Enabling snapshot comparison 

To benefit from Compare snapshot functionality you need enable and configure this feature in Space Tools. If functionality is not enabled - requirement macro shows the warning about that.

We get access to setting and administrating of comparison functioning after turning on comparison functionality in Space Tools.

  1. Turn On/Off functionality
  2. Snapshot interval field appears - intervals in which snapshot will be taken if there were change in content of pages related to requirements. 
  3. Snapshot table - List of snapshot available in history
  4. Date of creation of the snapshot
  5. Snapshot name (empty if not given), to give snapshot name you need to mouse over the snapshot line and click the "pencil" that appears, then give a name and click Enter
  6. Remove snapshot - possibility to remove snapshot from history
  7. Checkboxes to choose which snapshots to remove
  8. Remove selected - bulk removal of snapshots, removes those selected 


After snapshots settings in graph Compare button appears.

After click Compare button snapshots list appears

After selecting snapshot user is able to see the current version changes to compare to selected one, by three parameters:

  • Clarity
  • Size
  • Connections

  1. Snapshot selected for comparison
  2. Cancel  button - hides snapshot selected pulldown
  3. Clarity parameter change indication (left one is old, right one - current version) 
  4. Old connection
  5. New connection
  6. Size parameter change indication (pointer up - increased, pointer down - decreased)