Before you get started, make sure your Jira integration is setup. Here are the instructions.
Once connected, Enzyme is now the ‘Compliance Layer’ of your developer stack. There is a simple mapping to remember for daily use:
In Jira → In Enzyme
Epics labeled ‘UserNeed’ User Needs
Stories labeled ‘Requirement’ Requirements
Merged Pull requests referencing Jira issue ids Design Outputs
Linking to User Needs and Requirements
Let’s start with pushing stories as requirements (a similar workflow to Epics/User Needs)
- Create an issue in Jira, add the label “Requirement” and then Save.
- Navigate to Enzyme > Design and observe that the issue is now listed in requirements column.
- Open the card and observe the content of the Jira issue has been linked to the Requirement.
Linking to Design Outputs
Once a Jira story has been linked to an Enzyme requirement you can use the story id to link a pull request to the Design Outputs column.
This requires integrating source control with Enzyme. Instructions are in our support center HERE.
- Get the issue id associated with the requirement being implemented. EPKW-3 in the example below.
- Use the Jira issue ID and put it into the body of the Pull Request with the format
PRODUCTSHORTCODE/JIRA/IDas shown in the following image:
- This will fire a webhook to update the linking in Enzyme and link the Design Output created by this Pull Request with the Requirement created by the Jira issue.
NOTE: these can be updated at any time and Enzyme will remap accordingly. This his helpful when remediating projects where a lot of code has already been created and tracings need to be done retroactively. The same applies in both GitHub PRs and Jira issues.
When design control items are approved in Enzyme they will push a comment back to Jira indicating that the item has been approved.
If the Jira story linked to a Requirement is update then the Enzyme Requirement will go from Approved to Draft. Users can either approve the new change or revert it.
The intent is to help your engineers and PM who are comfortable with Jira to spend as much time there as possible, while keeping development compliant. Enzyme is the source of truth only for Jira issues which are relevant to the design control process.
Still have questions? Contact us.