Add more documentation
This commit is contained in:
parent
010145e36c
commit
1f1a0553b0
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
@ -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
|
||||
|
|
@ -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**.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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.
|
||||
Loading…
Reference in New Issue