summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/analytics-tasks.markdown24
-rw-r--r--docs/analytics.markdown35
-rw-r--r--docs/index.markdown1
3 files changed, 56 insertions, 4 deletions
diff --git a/docs/analytics-tasks.markdown b/docs/analytics-tasks.markdown
new file mode 100644
index 00000000..c5acea5f
--- /dev/null
+++ b/docs/analytics-tasks.markdown
@@ -0,0 +1,24 @@
+Analytics for tasks
+===================
+
+Each task have an analytics section available from the left menu in the task view.
+
+Lead and cycle time
+-------------------
+
+![Lead and cycle time](http://kanboard.net/screenshots/documentation/task-lead-cycle-time.png)
+
+- The lead time is the time between the task creation and the date of completion (task closed).
+- The cycle time is the time between the start date and the date of completion.
+- If the task is not closed the current time is used instead of the date of completion.
+- If the start date is not specified, the cycle time is not calculated.
+
+Note: You can configure an automatic action to define automatically the start date when you move a task to the column of your choice.
+
+Time spent into each column
+---------------------------
+
+![Time spent into each column](http://kanboard.net/screenshots/documentation/time-into-each-column.png)
+
+- This chart show the total time spent into each column for the task.
+- The time spent is calculated until the task is closed.
diff --git a/docs/analytics.markdown b/docs/analytics.markdown
index fb863531..810b5921 100644
--- a/docs/analytics.markdown
+++ b/docs/analytics.markdown
@@ -1,6 +1,8 @@
Analytics
=========
+Each project have an analytics section. Depending how you are using Kanboard, you can see those reports:
+
User repartition
----------------
@@ -20,7 +22,8 @@ Cumulative flow diagram
![Cumulative flow diagram](http://kanboard.net/screenshots/documentation/cfd.png)
-This chart show the number of tasks cumulatively for each column over the time.
+- This chart show the number of tasks cumulatively for each column over the time.
+- Everyday, the total number of tasks is recorded for each column.
Note: You need to have at least 2 days of data to see the graph.
@@ -30,13 +33,37 @@ Burndown chart
![Burndown chart](http://kanboard.net/screenshots/documentation/burndown-chart.png)
The [burn down chart](http://en.wikipedia.org/wiki/Burn_down_chart) is available for each project.
-This chart is a graphical representation of work left to do versus time.
-Kanboard use the complexity or story point to generate this diagram.
+- This chart is a graphical representation of work left to do versus time.
+- Kanboard use the complexity or story point to generate this diagram.
+- Everyday, the sum of the story points for each column is calculated.
+
+Average time spent into each column
+-----------------------------------
+
+![Average time spent into each column](http://kanboard.net/screenshots/documentation/average-time-spent-into-each-column.png)
+
+This chart show the average time spent into each column for the last 1000 tasks.
+
+- Kanboard use the task transitions to calculate the data.
+- The time spent is calculated until the task is closed.
+
+Average Lead and Cycle time
+---------------------------
+
+![Average time spent into each column](http://kanboard.net/screenshots/documentation/average-lead-cycle-time.png)
+
+This chart show the average lead and cycle time for the last 1000 tasks over the time.
+
+- The lead time is the time between the task creation and the date of completion.
+- The cycle time is time between the specified start date of the task to completion date.
+- If the task is not closed, the current time is used instead of the date of completion.
+
+Those metrics are calculated and recorded everyday for the whole project.
Don't forget to run the daily job for stats calculation
-------------------------------------------------------
-To generate accurate analytics data, you should run the daily cronjob **project daily statistics** just before midnight.
+To generate accurate analytics data, you should run the daily cronjob **project daily statistics**.
[Read the documentation about Kanboard CLI](cli.markdown)
diff --git a/docs/index.markdown b/docs/index.markdown
index bf315ee6..410cc402 100644
--- a/docs/index.markdown
+++ b/docs/index.markdown
@@ -33,6 +33,7 @@ Using Kanboard
- [Recurring tasks](recurring-tasks.markdown)
- [Create tasks by email](create-tasks-by-email.markdown)
- [Subtasks](subtasks.markdown)
+- [Analytics for tasks](analytics-tasks.markdown)
### Working with users