This documentation contains information about how work is performed within Teamapt’s Jira environment. It involves documenting workflows, issue types, statuses, transitions, screens, fields, and other configurations to ensure clarity, consistency, and efficiency in using Jira.
Features
Projects
- Create project: The "Create Project" feature in Jira allows you to set up a new workspace for managing your work.
Steps in creating a project - Click on the create project button as shown in the screenshot below
- Choose your type of project e.g software development
- Select a pre-configured template e.g scrum or kanban
- Give your project a clear and descriptive name
- Create Project
Video tutorial link:
https://www.youtube.com/watch?v=U8j5SAV06Ng
Epics
- Create Epic: An Epic is a large body of work which contains smaller tasks or user stories.
Steps in creating an epic - Go to the project where you want to create the Epic.
- Access the create issue button
- From the dropdown menu, choose the "Epic" issue type.
- Fill in the necessary information, such as the Epic's summary, description, assignee, components, initiative or any other relevant fields
- Once you've entered the required details, save the Epic.
NOTE: It is very important and compulsory that description is added to any epic created, so anyone reading the description can understand why the epic was created.
Video Tutorial link:
https://www.youtube.com/watch?v=ObpjFsib3Lc
Tasks
- Create Task/User story/Bug: These are different types of issues created to track various work items.
Steps in creating a task - Navigate to the desired epic
- Click on the "Create" button.
- Select "Task" “Story“ “Bug“ as the issue type.
- Fill in the required fields: summary, description, assignee, sprint, components, or any other relevant fields
- Click "Create".
NOTE: It is very important and compulsory that description and acceptance criteria is added to any task created, so anyone reading the description can understand why the task was created.(see screenshot below)
- Task Update: When a task is being worked on, it is important that the task is updated by moving it to “in progress”. To foster effective communication, comments should be added to tasks as shown in the screenshot below whenever there is a blocker or an update is to be given on the task.
- Timeline Update: Timeline update provides a visual representation of an epic/task progress over time.
- Go to timeline, click on the epic/task
- Drag and drop issues/tasks to adjust their start and due dates.
NOTE: It is very important and compulsory that timelines are added to any task created, so there can be clarity on when a task or epic will be completed.(see screenshot below)
Video tutorial link:
https://www.youtube.com/watch?v=kkl7Aw6Y-sM
- Components: Components in Jira are a way to categorise and organise issues within a project. This allows for better organisation, prioritisation, and tracking of specific areas of work.
How to create a component(refer to the image below)
Navigate to Your Project:
Go to your Jira project.
Open Project Settings:
Click on the project's settings cog.
Access Components Section:
Look for the "Components" section.
Create a New Component:
Click the "Add" button or a similar option.
Enter Component Details:
Provide a name for the component.
Optionally, add a description to explain the component's purpose.
Assign a lead or owner to the component (if applicable).
Save the Component:
Click the "Save" button to create the component.
- Initiatives: Initiatives in Jira are a strategic planning tool that allows you to connect high-level goals to the day-to-day tasks of the team.
How to create an initiative(refer to the image below)
In teamapt, we link all epics to initiatives to track progress, make sure goals align, and make decisions.
How to link epic to an initiative:
- Click on the epic
- Scroll to “details“ and look for the “parent“ field
- Click and add initiative from the existing list of initiatives
- Task Transition:
Task transitions in Jira refer to the movement of an issue (or task) from one status to another within its workflow. This represents the progression of the task through its lifecycle.