Audience: System Engineers, Engineering Leadership, Compliance teams, Quality teams, etc
Products Applicable: Jama Connect®
Use Case
Creating and working with checklists for quality purposes.
Best Practice
This describes how to configure checklists. The goal is to assess whether development teams adhere to the plans and standards established during the planning process.
Implementation
Activities
Tasks in Jama Connect™
Pre-configure the Checklist
Create a custom item type called "Checklist Item." Suggested additional fields:
Remarks
Compliance (picklist with values: Yes, No, N/A)
Assigned To
Status (workflow field if necessary to your organization)
Transition Control/Management
Use Workflow to establish each state's eligible transitions, permissions, and notifications.
Update the Status picklist to customize states.
Configure and enable project workflows.
Author Checklists
It is common practice to establish a project in Jama Connect to house libraries of reusable information. Checklists are perfect candidates for this.
Add a new set of checklist items in the Explorer Tree for a new checklist document. Name the set after the checklist name. Under the set, add new checklist items, such as "Was the requirement tested by a different resource from the requirement author?"
The screenshot below shows a small checklist contained in a Library.
Prepare a checklist for review.
For each artifact document, you need to review (for example, System Requirements Spec), reuse the appropriate checklist, and update the name with syntax to indicate which artifact document it is associated with.
Right-click the checklist set in the Explorer Tree and select Reuse. This allows the checklist to be used multiple times for different artifact documents and maintain a unique version history.
Update Checklists
Once the checklist document is reused and named according to the appropriate content it is checking, provide Yes / No / N/A adjudication for each checklist item.
In Jama Connect™ you can create a filter that displays all items under the checklist set AND all items under the content set (such as requirement/verification) that is being reviewed. This provides a unique view and URL that displays both the checklist and the content being reviewed. This filter can also be used to send to Review Center for final approval and sign-off.
Perform Reviews
Start a Review (optional)
Use the Review feature of Jama Connect™ to perform reviews.
One person (or multiple people) serves as the Moderator.
Moderators are responsible for starting the review and selecting the scope of items in a Review.
Scope of items in a Review is typically based on location in the Explorer Tree or a Jama Connect™ filter.
Checklist items can also be included in the Review before or after the content under review.
Moderators can invite participants and assign them one of two roles: Reviewer or Approver.
The moderator sets Review deadlines and Review instructions.
Facilitate the Review
Both Reviewers and Approvers can read and comment, but only Approvers can approve and e-sign content in a Review.
Moderators can review feedback and revise content directly in the Review.
Only Moderators can revise content in a Review based on the feedback.
When ready, Moderators can publish a new revision.
Baselines are automatically created for each review revision.
Close the Review
Reviews are considered closed when either:
The review Deadline has been reached.
Moderator closes the review early (for example, they receive sufficient feedback or signoff before the deadline) when the expiration date is reached.
Review deadlines can be extended/reopened.
Refer to the Jama Connect™ User Guide for how to facilitate Reviews.
Implementation Option
Activities
Tasks in Jama Connect™
Create an Editor Template
Create an editor template called Checklist. This is ideal for requirements checklist criteria that are limited to 10 or fewer.
Orient the checklist in a horizontal manner
Be sure it does not extend too far left and right (try 700)
Use color! Experiment to see what looks good!
Example:
Add checklist criteria to Requirement Item Type
Add a new rich text field to a requirement item:
Name of field = Checklist Criteria
Field Type = Rich text
Choose the editor template Called Checklist created in the step above
Review Center visibility
Make sure the checklist field is visible in Review Center view(s).
References
Definitions of key terms
Hyperlinks to key materials
Please feel free to leave feedback in the comments below.
Comments
0 comments
Please sign in to leave a comment.