jira cards

Mastering Jira: How to Write Effective Cards?

Learn how to create clear, well-organized Jira Cards for smoother project management

TASK-457

Add new section

Add section with sign-up form for the newsletter to the landing page

As a premium user I want to see a newsletter sign-up form on the landing page

Description

Add newsletter sign-up form to the landing page.

Add sign-up form to the landing page, only for the premium user. Add it to the bottom of the page, just before a footer. It should includes checkbox with agreement and button.

Text for the checkbox: I want to subscribe the newsletter
Text for the button: Subscribe

Add sign-up form to the landing page, only for the premium user. Add it to the bottom of the page, just before a footer. It should includes checkbox with agreement and button.

Text for the checkbox: I want to subscribe the newsletter
Text for the button: Subscribe

Context:
Currently, users do not have a direct option to subscribe to the newsletter. They have to contact support. The newsletter should only be available to users with a premium subscription.

Business Requirements:

  • Only premium users should see the sign-up form
  • The form should be located at the very bottom on our landing page, just before the footer
  • The form should includes: checkbox selection, and the submit button

Add sign-up form to the landing page, only for the premium user. Add it to the bottom of the page, just before a footer. It should includes checkbox with agreement and button.

Context:
Currently, users do not have a direct option to subscribe to the newsletter. They have to contact support. The newsletter should only be available to users with a premium subscription.

Business Requirements:

  • Only premium users should see the sign-up form
  • The form should be located at the very bottom on our landing page, just before the footer
  • The form should includes: checkbox, and the submit button
  • After submitting the form, display success alert with text "Thank you for subscribing to the newsletter. Check your email to claim your bonus!"

Designs:cat

Additional note:
Text for the checkbox: I want to subscribe the newsletter
Text for the button: Subscribe

Landing page

Add sign-up form to the landing page, only for the premium user. Add it to the bottom of the page, just before a footer. It should includes checkbox with agreement and button.

Context:
Currently, users do not have a direct option to subscribe to the newsletter. They have to contact support. The newsletter should only be available to users with a premium subscription.

Business Requirements:

  • Only premium users should see the sign-up form
  • The form should be located at the very bottom on our landing page, just before the footer
  • The form should includes: checkbox, and the submit button
  • After submitting the form, display success alert with text "Thank you for subscribing to the newsletter. Check your email to claim your bonus!"

Designs:cat

Additional note:
Text for the checkbox: I want to subscribe the newsletter
Text for the button: Subscribe

Acceptance Criteria

Scenario 1: Premium User Subscribes to Newsletter

Given:

  • User is logged in as a premium user
  • User is on the landing page

When:

  • User scrolls to the bottom of the landing page

Then:

  • User sees the newsletter sign-up form
  • User sees a checkbox labeled "I want to subscribe to the newsletter"
  • User sees a submit button labeled "Subscribe"
  • User enters their email address in the required field
  • User checks the checkbox to indicate their consent
  • User clicks the submit button

And:

  • The form validates the email address and consent checkbox
  • The form submits the data securely
  • The system displays a success alert with the proper message

Scenario 2: Non-Premium User Accesses the Landing Page

Given:

  • User is not logged in as a premium user
  • User is on the landing page

When:

  • User scrolls to the bottom of the landing page

Then:

  • User does not see the newsletter sign-up form
  • User does not have the option to subscribe to the newsletter

And:

  • The landing page does not display any content related to the newsletter sign-up form for non-premium users

Landing page

How to create well-defined Jira cards?


Jira is a powerful project management tool widely used for issue tracking, bug tracking, and agile project management. You probably use or plan to use this tool - that's a good thing. A well-organised workflow can significantly increase the efficiency of the whole team.

In this tutorial, we will discuss the key elements of a well-defined Jira card, and explore the benefits it brings to your project management process. Well-defined Jira cards are essential for efficient collaboration, and streamlined workflows.

To work effectively, you should familiarise yourself with the concept of the user story. It's a common way of describing functionality, which is a concise way of describing a feature from the perspective of the customer. User stories capture the user's needs, and desired outcomes, serving as a communication tool between stakeholders, product owners, and development teams.

We will build an example of the user story by adding a sign-up form for a page visible only to specific users.

You probably don't realise how poorly described requirements can slow down the whole process. Shall we get started?

The title

Let's start with the thing you create first when you set up a new card - the title.

The title of a Jira card should succinctly summarize the task or issue at hand. It should be descriptive enough to provide a clear understanding of what the card represents. A good title includes specific keywords related to the task, making it easier to search and categorize later.

Look at this example: The title "Add new section" doesn't include much information. When a team member would search for this particular card, for example, related to the newsletter sign-up form, he would have to remember that the "Add new section" is connected with the newsletter form.

The title "Add section with sign-up form for the newsletter to the landing page" is much more useful and shows the whole context in a few words.

Even better title

It often happens that the application is much more complicated and even this definition of the title is not sufficient. Let us assume that there are 2 types of users in the application: standard users and those with a premium subscription. The form we want to add should only be visible to users with a subscription. Adding this information will make it easier to segregate cards in the backlog and find a card more quickly. When browsing through the entire board, without going into the details, it will be immediately apparent what the developer is working on, the status of the card and what it is about.

The solution to an even more clearly defined title is to use the form "As a ... I want to ...":

  • As a (who wants to accomplish something)
  • I want to (what they want to accomplish)

Let's see this example, "As a premium user I want to see a newsletter sign-up form on the landing page" - it contains all the information you need. Reviewing the board or backlog will be more efficient, not only for developers, but also for product owners or managers.

The description

The card description is where you should put all the information you have.

The description section provides detailed information about the task. It should include all relevant details, such as background information, specific requirements, expected outcomes, and any other necessary context. A well-written description helps stakeholders, team members, and collaborators understand the purpose and scope of the task.

Generally speaking, the more useful and related information you add, the better.

Note that we have changed the description to add more specifics that the developer would sooner or later ask about. We can anticipate his need so that the card will not be blocked by the lack of all information.

Detailed description

In order to foster a deeper understanding and encourage valuable contributions, it is imperative to provide the team with a broader context for changes. By communicating the overall goal rather than just the individual steps, the team gains a holistic perspective and can offer suggestions for further improvements or identify any missing elements, ultimately driving enhanced outcomes.

You can incorporate business requirements in the description. By clearly outlining the specific needs and objectives of the organization, teams can align their efforts, make informed decisions, and prioritize work effectively.

Furthermore, it fosters effective communication and collaboration among stakeholders. It allows business owners, product managers, and development teams to have a shared understanding of the desired outcomes, facilitating discussions, decision-making, and prioritization of work.

Show me what you got

Don't forget to include other helpful information, such as designs. A picture is worth a thousand words. Sometimes even a simple design is more valuable than a incomplete description. Also, if you use a card's label in a team, don't forget to add one.

Jira also provides many other options, such as the ability to set card priority. Such information will allow the team to decide how to process the card.

Final remarks

  • Create a user story per specific actor. Try to avoid matching many actors into a single user story even though there are similar or the same user journeys
  • Always define a verb within the user story short description as this type of Jira card should reflect a user action that needs to be developed and tested
  • Try to include as many key words as possible in the title and description
  • By providing context and communicating the overall goal, not just the individual steps, the team gains a holistic perspective and can offer suggestions for further enhancements or identify any missing elements
  • Business Requirements describes all business details that are needed for developers in order to properly develop the feature without asking unnecessary questions

Bonus: Acceptance Criteria

To raise the quality of the card even further, you can add Acceptance Criteria, which are conditions that a software product must satisfy to be accepted by a user, customer, or other stakeholders. Ideally, these should be defined by the Product Owner or Business Analyst. One of the types is Scenario Based Acceptance Criteria, which are framed in the form of "Given, When, Then".

One of the significant advantages of using Scenario Based Acceptance Criteria is the seamless transition from requirements to testing. QA teams can leverage these criteria as a blueprint to design comprehensive E2E tests that cover various user interactions and system behaviors. Each scenario represents a specific user journey or use case, allowing QA engineers to simulate real-world scenarios and verify that the software behaves as intended.

Scenarios encourage collaboration and shared understanding among stakeholders, developers, and testers. They provide a common language to discuss requirements and help identify any gaps or misunderstandings early in the development process.