docs: improve documentation of the reference estimates

codescape · Feb 13, 2025 · c64d277 · c64d277
1 parent afc26db
commit c64d277
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -14,6 +14,7 @@ category: Administration
 * chore: simplify Docker configuration for testing
 * feat: ensure compatibility with Jira 10.3.0
 * feat: ensure compatibility with Jira 10.4.0
+* docs: improve documentation of the reference estimates
 
 ### [24.10.0] - 2024-10-29
 

diff --git a/docs/features.md b/docs/features.md
@@ -46,6 +46,13 @@ The user guide explains how to [participate in a Scrum Poker session](/participa
 
 When participants hover over the possible cards they can choose from during a Scrum Poker sessions they see a list of references to previous sessions they participated in with the same estimate agreed on.
 
+Reference estimates are calculated by the following formula:
+
+* the reference estimate has the hovered estimate as the agreed estimate 
+* the current user has either started the session, confirmed the estimate or participated on the session with a vote
+
+The reference estimates are sorted by age and the youngest sessions are presented first.
+
 See this feature in action in the user guide on the page that shows how to [participate in a Scrum Poker session](/participate-in-scrum-poker-session).
 
 ### Define your own card sets