Merge branch '338817-add-a-screenshot-to-productivity-analytics-doc' into 'master'

Resolve "Add a screenshot to Productivity Analytics doc"

See merge request gitlab-org/gitlab!71098

doc/user/analytics/productivity_analytics.md

@@ -16,37 +16,79 @@ long, on average, it takes to deliver features is an enormous endeavor.
 While [Value Stream Analytics](../analytics/value_stream_analytics.md) focuses on the entire
 Software Development Life Cycle (SDLC) process, Productivity Analytics provides a way for Engineering Management to drill down in a systematic way to uncover patterns and causes for success or failure at an individual, project, or group level.
 
-Productivity can slow down for many reasons ranging from degrading codebase to quickly growing teams. In order to investigate, department or team leaders can start by visualizing the time it takes for merge requests to be merged.
+Productivity can slow down for many reasons ranging from degrading codebase to quickly growing teams. To investigate, department or team leaders can start by visualizing the time it takes for merge requests to be merged.
 
-## Supported features
+## Visualizations and metrics
 
-Productivity Analytics allows GitLab users to:
+With Productivity Analytics, GitLab users can:
 
-- Visualize typical merge request (MR) lifetime and statistics. Use a histogram that shows the distribution of the time elapsed between creating and merging merge requests.
-- Drill down into the most time consuming merge requests, select a number of outliers, and filter down all subsequent charts to investigate potential causes.
+- Visualize typical merge request (MR) lifetime and statistics. A histogram shows the distribution of the time elapsed between creating and merging merge requests.
+- Drill down into the most time consuming merge requests, select outliers, and filter subsequent charts to investigate potential causes.
 - Filter by group, project, author, label, milestone, or a specific date range. For example, filter down to the merge requests of a specific author in a group or project during a milestone or specific date range.
-- Measure velocity over time. Visualize the trends of each metric from the charts above over time in order to observe progress. Zoom in on a particular date range if you notice outliers.
+- Measure velocity over time. To observe progress, visualize the trends of each metric from the charts over time. Zoom in on a particular date range if you notice outliers.
 
-## Accessing metrics and visualizations
+## Metrics charts
 
-To access the chart, navigate to a group's sidebar and select **Analytics > Productivity Analytics**.
+To access the charts, navigate to a group's sidebar and select **Analytics > Productivity Analytics**.
+Metrics and visualizations of **merged** merge requests are available on a project or group level.
 
-The following metrics and visualizations are available on a project or group level - currently only covering **merged** merge requests:
+### Time to merge
 
-- Histogram showing the number of merge request that took a specified number of days to merge after creation. Select a specific column to filter down subsequent charts.
-- Histogram showing a breakdown of the time taken (in hours) to merge a merge request. The following intervals are available:
-  - Time from first commit to first comment.
-  - Time from first comment until last commit.
-  - Time from last commit to merge.
-- Histogram showing the size or complexity of a merge request, using the following:
-  - Number of commits per merge request.
-  - Number of lines of code per commit.
-  - Number of files touched.
-- Scatterplot showing all MRs merged on a certain date, together with the days it took to complete the action and a 30 day rolling median.
-- Table showing the list of merge requests with their respective time duration metrics.
-  - Users can sort by any of the above metrics.
+The **Time to merge** histogram shows the number of merge requests and the number 
+of days it took to merge after creation. Select a column to filter subsequent charts.
 
-## Date ranges
+![Metrics for number of days merge requests per number of days](img/productivity_analytics_time_to_merge_v14_4.png)
+
+### Trendline
+
+The **Trendline** scatterplot shows all merge requests on a certain date, 
+and the days it took to complete the action and a 30 day rolling median. Select the dropdown to view:
+
+- Time from first commit to first comment.
+- Time from first comment until last commit.
+- Time from last commit to merge.
+- Number of commits per merge request.
+- Number of lines of code (LOC) per commit.
+- Number of files touched.
+
+![Metrics for amount of merge requests merged on a certain date](img/productivity_analytics_trendline_v14_4.png)
+
+### Commits and merge request size
+
+Under the **Trendline** scatterplot, the left-side histogram shows 
+the time taken (in hours) between commits and comments until the merge 
+request is merged. Select the dropdown to view:
+
+- Time from first commit to first comment.
+- Time from first comment until last commit.
+- Time from last commit to merge.
+
+The right-side histogram shows the size or complexity of a merge request. 
+Select the dropdown to view:
+  
+- Number of commits per merge request.
+- Number of lines of code (LOC) per commit.
+- Number of files touched.
+
+![Metrics for amount of commits and complexity of changes per merge request.](img/product_analytics_commits_per_mr_v14_4.png)
+
+### Merge request list
+
+The **List** table shows a list of merge requests with their respective time duration metrics. 
+
+Sort metrics by:
+
+- Time from first commit to first comment.
+- Time from first comment until last commit.
+- Time from last commit to merge.
+
+Filter metrics by:
+ 
+- Number of commits per merge request.
+- Number of lines of code per commit.
+- Number of files touched.
+
+## Filter by date range
 
 > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13188) in GitLab 12.4.