Personal Training Projects
What problem(s) will it solve?
What problem do we solve?
We need a way to track individuals accomplishments of OJT and JQR items. Currently planning on tracking OJT signoff's using paper copies of records. These are not only awkward but waste resources (paper), are prone to loss and damage, and are not searchable.
Try to define the who/what/why of the opportunity as a user story. For example, "As a (who), I want (what), so I can (why/value)."
Who is the intended user(s)?
Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later. Personas are described here
Lay out the expected user experience
What is the single user experience workflow this problem addresses? For example, "The user should be able to use the UI/API/.gitlab-ci.yml with GitLab to " Gitlab UX Docs
Proposal
How are we going to solve the problem? Try to include the user journey! Gitlab Journeys
Create an individual training project with each item as an issue in the repository
Further details
Include use cases, benefits, goals, or any other details that will help us understand the problem better.
Permissions and Security
What permissions are required to perform the described actions? Are they consistent with the existing permissions as documented for users, groups, and projects as appropriate? Is the proposed behavior consistent between the UI, API, and other access methods (e.g. email replies)?
Documentation
See the Feature Change Documentation Workflow Gitlab Feature Change Workflow
- Add all known Documentation Requirements in this section. See Gitlab Dev Docs
- If this feature requires changing permissions, update the permissions document. See Gitlab Permissions
Availability & Testing
See the test engineering planning process and reach out to your counterpart Software Engineer in Test for assistance: Gitlab Test Planning
This section needs to be retained and filled in during the workflow planning breakdown phase of this feature proposal, if not earlier.
What risks does this change pose to our availability? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing?
Please list the test areas (unit, integration and end-to-end) that needs to be added or updated to ensure that this feature will work as intended. Please use the list below as guidance.
- Unit test changes
- Integration test changes
- End-to-end test change
What does success look like, and how can we measure that?
Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this.