diff options
| author | Frederic Guillot <fred@kanboard.net> | 2015-02-21 21:05:56 -0500 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2015-02-21 21:05:56 -0500 |
| commit | 19d061db714252976b2ef53f5df2813c396b401a (patch) | |
| tree | 5d2b707cc10a86f735f5ae750a96aeddcb5933fa /docs | |
| parent | 2b3f0b6179fe5215c4bd34e25a725e653d4ce1db (diff) | |
Update documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/board-configuration.markdown | 17 | ||||
| -rw-r--r-- | docs/calendar.markdown | 14 | ||||
| -rw-r--r-- | docs/keyboard-shortcuts.markdown | 15 | ||||
| -rw-r--r-- | docs/link-labels.markdown | 11 | ||||
| -rw-r--r-- | docs/task-links.markdown | 22 | ||||
| -rw-r--r-- | docs/time-tracking.markdown | 38 |
6 files changed, 117 insertions, 0 deletions
diff --git a/docs/board-configuration.markdown b/docs/board-configuration.markdown index 174618c2..f381ebf9 100644 --- a/docs/board-configuration.markdown +++ b/docs/board-configuration.markdown @@ -41,3 +41,20 @@ Categories are not global to the application but attached to a project. Each project can have different categories. However, if you always create the same categories for all your projects, you can define here the list of categories to create automatically. + +### Allow only one subtask in progress at the same time for a user + +When this option is enabled, a user can work with only one subtask at the time. + +If another subtask have the status "in progress", the user will see this dialog box: + + + +### Enable time tracking for subtasks + +When this option is enabled, each time the status of a subtask is changed, the start time and the end time are recorded in the database for the assignee. + +- When the status changes to "in progress" then the start time is saved +- When the status changes to "done" then the end time is saved + +The time spent for the subtask and the task is also updated. diff --git a/docs/calendar.markdown b/docs/calendar.markdown new file mode 100644 index 00000000..7b5be5fb --- /dev/null +++ b/docs/calendar.markdown @@ -0,0 +1,14 @@ +Calendar +======== + +There are two different views for the calendar: + +- The project view with filters (available from the board) +- The user view (available from the dashboard and from the user section) + +At this time the calendar is able to display these information: + +- Tasks with a due date, displayed at the top. The date can be changed by moving the task to another day. +- Subtask time tracking, each recorded time slot will be shown in the calendar. + + diff --git a/docs/keyboard-shortcuts.markdown b/docs/keyboard-shortcuts.markdown new file mode 100644 index 00000000..a11caccc --- /dev/null +++ b/docs/keyboard-shortcuts.markdown @@ -0,0 +1,15 @@ +Keyboard shortcuts +================== + +Board view +---------- + +- New task = **n** +- Expand/collapse tasks = **s** + +Application +----------- + +- Open board switcher = **b** +- Close dialog box = **ESC** +- Submit a form = **CTRL+ENTER** or **⌘+ENTER** diff --git a/docs/link-labels.markdown b/docs/link-labels.markdown new file mode 100644 index 00000000..e6423566 --- /dev/null +++ b/docs/link-labels.markdown @@ -0,0 +1,11 @@ +Link settings +============= + +Task relations can be changed from the application settings (**Settings > Link settings**) + + + +Each label may have an opposite label defined. +If there is no opposite, the label is considered bi-directionnal. + + diff --git a/docs/task-links.markdown b/docs/task-links.markdown new file mode 100644 index 00000000..1eab51fd --- /dev/null +++ b/docs/task-links.markdown @@ -0,0 +1,22 @@ +Task Links +========== + +Tasks can be linked together with predefined relationships: + + + +The default relationships are: + +- **relates to** +- **blocks** | is blocked by +- **is blocked by** | blocks +- **duplicates** | is duplicated by +- **is duplicated by** | duplicates +- **is a child of** | is a parent of +- **is a parent of** | is a child of +- **targets milestone** | is a milestone of +- **is a milestone of** | targets milestone +- **fixes** | is fixed by +- **is fixed by** | fixes + +Those labels can be changed in the application settings. diff --git a/docs/time-tracking.markdown b/docs/time-tracking.markdown new file mode 100644 index 00000000..575a0094 --- /dev/null +++ b/docs/time-tracking.markdown @@ -0,0 +1,38 @@ +Time Tracking +============= + +Time tracking information can be defined at the task level or at the subtask level. + +Task time tracking +------------------ + + + +Tasks have two fields: + +- Time estimated +- Time spent + +These values represents hours of work and have to be set manually. + +Subtask time tracking +--------------------- + + + +Subtasks also have the fields "time spent" and "time estimated". +However, when you set a value for those fields, **the task time tracking values becomes the sum of all subtask values**. + +User time tracking +------------------ + +In the board settings, you can enable subtasks time tracking for users. + +Each time a subtask status change, the start time and the end time are saved in a seperate table automatically. +The time spent is automatically calculated for tasks and subtasks when the subtask is completed. + +- Changing subtask status from "todo" to "in pogress" logs the start time +- Changing subtask status from "in progress" to "done" logs the end time but also update the time spent of the subtask and the task + +The breakdown by user is also visible in the tasks details: +I
\ No newline at end of file |