Time Tracking Tutorial
The Time Tracking features lets you and your team report the amount of time spent working on issues in your project. This feature helps agencies track how much effort has been spent for different clients and lets development teams measure how the actual work compares to their original estimation. With this feature enabled:
- Your team can add work items to issues.
- YouTrack calculates the total spent time that is recorded in each issue.
- You can create summary reports that show total spent time for different types of work.
This tutorial shows you how to configure time tracking in YouTrack and use the feature in your project.
Enable Time Tracking
The first step is sto enable the time tracking feature in your project.
To enable time tracking:
- Click the name of the project on the Projects page.
- Click the Edit project link.
- Select the Time Tracking tab.
- Select the Enable time tracking check box.
Configure Estimation and Spent Time
With time tracking, you can estimate how much time you expect to spend to resolve each issue. This estimation is stored as a period type.
The amount of time spent that is entered in each work item is also stored as a period type. This field records the total amount of time that is reported for all work items in the issue. You cannot update this value manually — only by adding or editing work items.
The amount that is recorded as spent time is compared to the value that is stored in another
period type field that stores estimations. The field that stores the estimation presents this calculation in a progress indicator. The amount of spent time that does not exceed the original estimation is drawn in green. The missing piece of the pie represents the amount of time that is left over. The time left and estimation are displayed in a tooltip when you move the pointer over the progress indicator.
When the spent time exceeds the original estimation, the progress indicator is drawn as a red circle. The tooltip displays the amount of spent time that exceeds the original estimation.
If your project already includes fields for Estimation and Spent Time that use the period field type, YouTrack uses these fields by default for time tracking. Otherwise, YouTrack suggests that you add these fields to your project.
Add Work Item Types
The next thing you need to decide is what type of work you want to track.
You may wish to count time that is spent working on issues separately for developers, QA engineers, technical writers, and so on. Each piece of work to be logged with YouTrack is recorded as a work item. Each work item has a type and a duration. The term work item is used differently in some books on Agile practices; in YouTrack, a work item is not the same as an issue, task, or ticket.
An administrator can define work items at the global level on the Time Tracking page under the Administration menu. For more information, see Time Tracking.
Log Spent Time
YouTrack associates work items with a specific issue. In other words, you can log multiple work items that represent work related to the same issue. In full page view, YouTrack shows a list of work items that have been added to an issue on the Time Tracking tab. This tab is only visible if time tracking is enabled in the project.
Users can log time spent working on an issue in minutes, hours, days or weeks. These units of time are referenced with abbreviations such as 1m, 1h, 1d, and 1w.
To add a work item to an issue:
- Open the issue in full page view.
- Select the Time Tracking tab:
- The current date is assigned to the work item by default. To change the date, click the date link and select another date from the calendar.
- Enter an optional comment.
- Enter the amount of time spent in the format
#w#d#h#m. The durations are calculated automatically. For example, if you enter
120m, the duration is set to
2hwhen the work item is added to the issue.
- Select a work item type from the drop-down list.
- Click the Submit button.
To add a work item with a command, just start typing. For example, if you type
add work 1w worked on the feature integration, a work item with the duration of one week and the description "worked on the feature integration" is added to the selected issue.
For issues that are linked as the parent for other issues, YouTrack automatically calculates the spent time as the sum of values that are added to each subtask. This information is displayed on the Time Tracking tab of the parent task.
If you add work items to a parent task, the spent time in the parent task includes spent time from work items that are added to the parent task plus the total spent time for each of its subtasks. For this reason, we generally recommend that you avoid adding work items to parent tasks.
Track Estimations and Spent Time
The values for the Estimation and Spent Time fields are shown for each issue individually. The Estimation and Spent Time for parent tasks are calculated as the sum of the corresponding values for each subtask.
- If you add work items to a parent task, the spent time in the parent task includes spent time from work items that are added to the parent task plus the total spent time for each of its subtasks. For this reason, we generally recommend that you avoid adding work items to parent tasks.
- If you change the estimation for a parent task, the synchronization between the parent task and its subtasks is broken. To restore the synchronization and calculate the estimation for the parent task automatically, set the estimation value in the parent task to the total estimation for each of of its subtasks.
Report Your Efforts
To create a report:
- Click the Reports link in the main navigation.
- Under the Time Management Reports section of the page, click the Time report link.
- Enter a name for the report.
- Select one or more projects from the drop-down list.
- Select a time period.
- To group work items on the report, select a Group by option from the drop-down list.
- To make the report visible to a specific group, select a group from the Visible to drop-down list.
- Click the Create report button
- A time report is generated for the selected projects.
- The report shows all work items recorded within the specified period.
The work items in this example are grouped by work item type.
The default presentation for the report is to show work items per issue (as shown in the example above). To view the time report by user, click the Per User button on the report page. If you just created the report, you may need to click Refresh after changing the view settings.
Both views (per issue and per user) let you view the total time that was spent on different types of activities, such as development, testing, documentation, or graphic design. To see the detailed report, select the Show work types check box next to the grouping option.
Automate Time Tracking with Workflows
In YouTrack, a workflow is a set of rules that automate a particular task. A rule is basically a script that YouTrack executes. For more details on workflows, please refer to the Workflow Tutorial.
For time management, there are three ready-to-use workflows available in YouTrack:
- The In Progress Work Timer workflow automatically logs the time which an issue spends in the In Progress state.
- The Stopwatch-style Work Timer workflow lets users add work items automatically when they stop a timer.
- The Pomodoro Timer workflow helps you use the Pomodoro technique in your time management.
You can also write your own workflows for advanced time management. If the existing workflows do not reflect your needs, please refer to the Workflow Tutorial.
Track Time on an Agile Board
If you follow an agile development process in your projects, there is a separate tutorial that shows you how to use time management with an agile board in YouTrack.