diff options
| -rw-r--r-- | README.markdown | 5 | ||||
| -rw-r--r-- | docs/board-configuration.markdown | 6 | ||||
| -rw-r--r-- | docs/budget.markdown | 34 | ||||
| -rw-r--r-- | docs/currency-rate.markdown | 11 | ||||
| -rw-r--r-- | docs/hourly-rate.markdown | 11 | ||||
| -rw-r--r-- | docs/timetable.markdown | 46 | ||||
| -rw-r--r-- | docs/transitions.markdown | 20 |
7 files changed, 133 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index bf513515..a85adeac 100644 --- a/README.markdown +++ b/README.markdown @@ -74,16 +74,20 @@ Documentation - [Project permissions](docs/project-permissions.markdown) - [Swimlanes](docs/swimlanes.markdown) - [Calendar](docs/calendar.markdown) +- [Budget](docs/budget.markdown) #### Working with tasks - [Creating tasks](docs/creating-tasks.markdown) - [Task links](docs/task-links.markdown) +- [Transitions](docs/transitions.markdown) - [Time tracking](docs/time-tracking.markdown) #### Working with users - [User management](docs/user-management.markdown) +- [Hourly rate](docs/hourly-rate.markdown) +- [Timetable](docs/timetable.markdown) - [Two factor authentication](docs/2fa.markdown) #### Settings @@ -92,6 +96,7 @@ Documentation - [Application settings](docs/application-configuration.markdown) - [Board settings](docs/board-configuration.markdown) - [Link settings](docs/link-labels.markdown) +- [Currency rate](docs/currency-rate.markdown) ### Integrations diff --git a/docs/board-configuration.markdown b/docs/board-configuration.markdown index f381ebf9..dda9787f 100644 --- a/docs/board-configuration.markdown +++ b/docs/board-configuration.markdown @@ -58,3 +58,9 @@ When this option is enabled, each time the status of a subtask is changed, the s - When the status changes to "done" then the end time is saved The time spent for the subtask and the task is also updated. + +### Show subtask estimates in the user calendar + +When enabled, assigned subtasks with the status "todo" and with a defined estimate value will be displayed on the user calendar. + +The user calender is available on the dashboard or from the user profile.
\ No newline at end of file diff --git a/docs/budget.markdown b/docs/budget.markdown new file mode 100644 index 00000000..63408d46 --- /dev/null +++ b/docs/budget.markdown @@ -0,0 +1,34 @@ +Budget management +================= + +Budget management is based on the subtask time tracking, the user timetable and the user hourly rate. + +This section is available from project settings page: **Project > Budget**. There is also a shortcut from the dropdown menu on the board. + +Budget lines +------------ + + + +Budget lines are used to define a budget for the project. +This budget can be adjusted by adding a new entry with an effective date. + +Cost breakdown +-------------- + + + +Based on the subtask time tracking table and user information you can see the cost of each subtask. + +The time spent is rounded to nearest quarter. + +Budget graph +------------ + + + +Finally, by combining all information we can generate a graph: + +- Expenses represents user cost +- Budget lines are the provisioned budget +- Remaining is the budget left at the given time diff --git a/docs/currency-rate.markdown b/docs/currency-rate.markdown new file mode 100644 index 00000000..b959e4d1 --- /dev/null +++ b/docs/currency-rate.markdown @@ -0,0 +1,11 @@ +Currency Rate +============== + +Since each user can have a predefined hourly rate in different currency. +If you have to handle multiple currencies, you define here the rate according to the reference currency. + +This feature is used for project budget calculation. + + + +Currency rate settings are located in **Settings > Currency rates**.
\ No newline at end of file diff --git a/docs/hourly-rate.markdown b/docs/hourly-rate.markdown new file mode 100644 index 00000000..172f2f47 --- /dev/null +++ b/docs/hourly-rate.markdown @@ -0,0 +1,11 @@ +Hourly Rate +=========== + +Each user can have a predefined hourly rate. +This feature is used for budget calculation. + +To define a new price, go to **User profile > Hourly rates**. + + + +Each hourly rate can have an effective date and and different currency. diff --git a/docs/timetable.markdown b/docs/timetable.markdown new file mode 100644 index 00000000..5d2f4c86 --- /dev/null +++ b/docs/timetable.markdown @@ -0,0 +1,46 @@ +User Timetable +============== + +Each user can have a predefined timetable. +This feature mainly is used for time tracking, project budget calculation and to display subtasks in the calendar. + +Each user have his own timetable. At the moment, that need to be specified manually for each person. +You can also schedule time-off or overtime. + +The timetable section is available from the user profile: **User profile > Timetable**. + +Work timetable +-------------- + +This timetable is dynamically calculated according to the regular week timetable, time-off and overtime. + + + +Week timetable +-------------- + + + +The week timetable is used to define regular work hours for the selected user. + +To add a new time slot, just select the day of the week and the time range. + +Time off timetable +------------------ + +The time-off timetable is used to schedule not worked time slot. +This time is deducted from the regular work hours. + +When you check the box "All day", the regular day timetable is used to define the regular work hours. + +Overtime timetable +------------------ + + + +The overtime timetable is used to define worked hours outside of regular hours. + +Day timetable +------------- + +This timetable is used when the checkbox "All day" is checked for overtime and time-off entries. diff --git a/docs/transitions.markdown b/docs/transitions.markdown new file mode 100644 index 00000000..c32f696a --- /dev/null +++ b/docs/transitions.markdown @@ -0,0 +1,20 @@ +Task transitions +================ + +Transitions record each movement of the tasks between columns. + + + +Available from the task view, you can see those information: + +- Date of the action +- Source column +- Destination column +- Executer (user that move the task) +- Time spent in the origin column + +Task transition data can also be exported from the project settings page. + + + +For the specified time range you will generate a CSV file that you can use with any spreadsheet software. |