Getting started
- Install Scenario Book from the Atlassian Marketplace. A Jira admin approves what the app may do. The list matches the scopes we explain on the Security page.
- Turn it on for a project. Project settings → Apps → Scenario Book → tick Use Scenario Book in your project. A project admin or Jira admin can do this.
- Check the defaults on the same page:
- Folder for feature files: where files live in your repository. Default
features/. - Tag that links a scenario to a story: default
@{key}, so@PAY-20links a scenario to PAY-20. Changing it doesn't rewrite tags already written. - Tag for manual scenarios: default
@manual. Manual scenarios are listed but never expect a pipeline result.
- Folder for feature files: where files live in your repository. Default
- Open a story and find the Scenarios panel. Choose Add scenario, pick or create a feature file, write it, and save.
- Open the project page (Scenario Book in the project sidebar) to see every feature file, read them as documentation, import and export.
Who can do what
| To | You need, in Jira |
|---|---|
| Read scenarios, feature files and results | Browse projects on that project |
| Add, edit, delete or restore scenarios | Edit issues on every story they belong to, and in the project |
| Move or rename feature files and folders | Edit issues in the project |
| Import into a project | Edit issues on the stories the import links to |
| Change project settings, create or revoke sync keys | Administer projects (or Jira admin) |
| See the app's totals across the site | Jira admin |
Scenario Book checks these as you, every time, in Jira itself. It never gives anyone more than Jira does.