Fix typo in documentation

This commit is contained in:
Frederic Guillot
2015-12-06 23:00:58 -05:00
parent 5c84996ee7
commit 7f3bf38e8d
84 changed files with 333 additions and 614 deletions

View File

@@ -1,7 +1,7 @@
Analytics
=========
Each project have an analytics section. Depending how you are using Kanboard, you can see those reports:
Each project have an analytics section. Depending on how you are using Kanboard, you can see those reports:
User repartition
----------------
@@ -22,21 +22,21 @@ 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.
- Everyday, the total number of tasks is recorded for each column.
- This chart shows the number of tasks cumulatively for each column over the time.
- Every day, the total number of tasks is recorded for each column.
- If you would like to exclude closed tasks, change the [global project settings](project-configuration.markdown).
Note: You need to have at least 2 days of data to see the graph.
Note: You need to have at least two days of data to see the graph.
Burndown chart
--------------
Burn down 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.
- 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
@@ -44,9 +44,9 @@ 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.
This chart shows the average time spent into each column for the last 1000 tasks.
- Kanboard use the task transitions to calculate the data.
- Kanboard uses the task transitions to calculate the data.
- The time spent is calculated until the task is closed.
Average Lead and Cycle time
@@ -54,17 +54,17 @@ 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.
This chart show the average lead and cycle time for the last 1000 tasks over 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.
- The cycle time is time between the specified start date of the task to the 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.
Those metrics are calculated and recorded every day for the whole project.
Don't forget to run the daily job for stats calculation
Don't forget to run the daily job for statistics calculation
-------------------------------------------------------
To generate accurate analytics data, you should run the daily cronjob **project daily statistics**.
To generate accurate analytic data, you should run the daily cronjob **project daily statistics**.
[Read the documentation about Kanboard CLI](cli.markdown)
[Read the documentation of Kanboard CLI](cli.markdown)