Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

📋 Overview

🗣 Voice and tone

✍ Writing principles


<Principle 1>

Whenever possible, offer a solution


While it's important to be direct in error messages, it's equally important to be helpful. Avoid messaging that focuses on the problem without offering a solution or way forward:


...

Your password's too short


...

Don't


Instead, help the people who use your product understand why they're experiencing an error and how they can avoid similar errors in the future:


...

Choose a password that is at least 8 characters long


...

Do


<Principle 2>

<Principle 3>

...

The TestSpell - BDD & Cucumber for Jira plugin has been designed to provide an integrated end-to-end solution in Jira, for testing projects that use BDD. The functionality described in this user guide covers the setup and organization of Gherkin scenarios, linking them to User Stories to improve Collaboration within the project team, manual execution of tests, integration with an automated framework for execution and reporting, and powerful test automation results integration with Jira.