Before you get started, make sure your Jira integration is set up. Here are the instructions.
Once connected, Enzyme is now the ‘Compliance Layer’ of your developer stack. You will be able to link issues to Design Control cards along with adding tracing dependencies within Jira.
Here is 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
Test labeled 'Verifications' Verifications
Test labeled 'Validations' Validations
Inward Descriptions are used when the design control workflow moves left to right in Enzyme.
- Example: User Needs can have Requirements & Validations - Use an Inward Description to link the User Needs to Requirements & Validations
Outward Descriptions are used when the design control workflow moves right to left in Enzyme.
- Example: Verification can have Requirements & Design Outputs - Use an Outward Description to link Verifications to Requirements & Design Outputs.
Linking to a Design Control Card in Enzyme (User Needs, Requirements, Design Outputs, Verifications & Validations)
Let’s start with pushing an issue as a requirement that is linked to a user need and verification (similar workflow to user needs, design outputs, verifications & validations).
- Create an issue in Jira, add the label “Requirement”.
- Next, select the Linked Issues that match the Issue you want to link and click Save.
Example: To link requirements to user needs, select [Outward Description] and select the corresponding user need. If you want to link a user needs to requirements, select [Inward Description] and select the corresponding requirement.
- Navigate to Enzyme > Design and observe that the issue is now listed in the requirements column.
- Open the card and observe the content of the Jira issue has been linked to the Requirement along with the appropriate tracing dependencies.
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 to 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.
If you have any questions, you can reach us through the in-app chat or email us at firstname.lastname@example.org.