debian-mirror-gitlab/.gitlab/issue_templates/Feature proposal - detailed.md

135 lines
9.3 KiB
Markdown
Raw Normal View History

2020-11-24 15:15:51 +05:30
<!-- The first section "Release notes" is required if you want to have your release post blog MR auto generated. Currently in BETA, details on the **release post item generator** can be found in the handbook: https://about.gitlab.com/handbook/marketing/blog/release-posts/#release-post-item-generator and this video: https://www.youtube.com/watch?v=rfn9ebgTwKg. The next four sections: "Problem to solve", "Intended users", "User experience goal", and "Proposal", are strongly recommended in your first draft, while the rest of the sections can be filled out during the problem validation or breakdown phase. However, keep in mind that providing complete and relevant information early helps our product team validate the problem and start working on a solution. -->
2021-01-03 14:25:43 +05:30
### Release notes
2020-11-24 15:15:51 +05:30
<!-- What is the problem and solution you're proposing? This content sets the overall vision for the feature and serves as the release notes that will populate in various places, including the [release post blog](https://about.gitlab.com/releases/categories/releases/) and [Gitlab project releases](https://gitlab.com/gitlab-org/gitlab/-/releases). " -->
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
### Problem to solve
2019-05-05 18:10:48 +05:30
2020-10-24 23:57:45 +05:30
<!-- What problem do we solve? 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)." -->
2019-05-05 18:10:48 +05:30
2019-07-07 11:18:12 +05:30
### Intended users
2019-05-05 18:10:48 +05:30
2019-07-07 11:18:12 +05:30
<!-- 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.
2019-12-04 20:38:33 +05:30
2020-04-22 19:07:51 +05:30
Personas are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/
2020-05-24 23:13:21 +05:30
* [Cameron (Compliance Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#cameron-compliance-manager)
2019-12-04 20:38:33 +05:30
* [Parker (Product Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#parker-product-manager)
* [Delaney (Development Team Lead)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead)
* [Presley (Product Designer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#presley-product-designer)
2020-05-24 23:13:21 +05:30
* [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer)
2022-05-07 20:08:51 +05:30
* [Priyanka (Platform Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#priyanka-platform-engineer)
2019-12-04 20:38:33 +05:30
* [Sidney (Systems Administrator)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator)
* [Sam (Security Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sam-security-analyst)
2021-01-03 14:25:43 +05:30
* [Rachel (Release Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#rachel-release-manager)
2020-05-24 23:13:21 +05:30
* [Alex (Security Operations Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#alex-security-operations-engineer)
2020-04-08 14:13:33 +05:30
* [Simone (Software Engineer in Test)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#simone-software-engineer-in-test)
2021-01-03 14:25:43 +05:30
* [Allison (Application Ops)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#allison-application-ops)
2022-05-07 20:08:51 +05:30
* [Ingrid (Infrastructure Operator)](https://about.gitlab.com/handbook/product/personas/#ingrid-infrastructure-operator)
* [Dakota (Application Development Director)](https://about.gitlab.com/handbook/product/personas/#dakota-application-development-director)
2020-05-24 23:13:21 +05:30
* [Dana (Data Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#dana-data-analyst)
2021-01-29 00:20:46 +05:30
* [Eddie (Content Editor)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#eddie-content-editor)
2022-05-07 20:08:51 +05:30
2020-05-24 23:13:21 +05:30
-->
2019-05-05 18:10:48 +05:30
2020-05-24 23:13:21 +05:30
### User experience goal
2021-01-03 14:25:43 +05:30
<!-- What is the single user experience workflow this problem addresses?
2020-05-24 23:13:21 +05:30
For example, "The user should be able to use the UI/API/.gitlab-ci.yml with GitLab to <perform a specific task>"
2022-11-25 23:54:43 +05:30
https://about.gitlab.com/handbook/product/ux/ux-research-training/user-story-mapping/ -->
2019-05-05 18:10:48 +05:30
2019-07-07 11:18:12 +05:30
### Proposal
2019-05-05 18:10:48 +05:30
2019-07-07 11:18:12 +05:30
<!-- How are we going to solve the problem? Try to include the user journey! https://about.gitlab.com/handbook/journeys/#user-journey -->
2019-05-05 18:10:48 +05:30
2020-05-24 23:13:21 +05:30
### Further details
<!-- Include use cases, benefits, goals, or any other details that will help us understand the problem better. -->
2019-07-07 11:18:12 +05:30
### Permissions and Security
2019-05-05 18:10:48 +05:30
2020-07-28 23:09:34 +05:30
<!-- 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)?
Consider adding checkboxes and expectations of users with certain levels of membership https://docs.gitlab.com/ee/user/permissions.html
* [ ] Add expected impact to members with no access (0)
* [ ] Add expected impact to Guest (10) members
* [ ] Add expected impact to Reporter (20) members
2021-01-03 14:25:43 +05:30
* [ ] Add expected impact to Developer (30) members
2020-07-28 23:09:34 +05:30
* [ ] Add expected impact to Maintainer (40) members
2022-05-07 20:08:51 +05:30
* [ ] Add expected impact to Owner (50) members
2022-04-04 11:22:00 +05:30
2022-05-07 20:08:51 +05:30
Please consider performing a threat model for the code changes that are introduced as part of this feature. To get started, refer to our Threat Modeling handbook page https://about.gitlab.com/handbook/security/threat_modeling/#threat-modeling.
2022-04-04 11:22:00 +05:30
Don't hesitate to reach out to the Application Security Team (`@gitlab-com/gl-security/appsec`) to discuss any security concerns.
-->
2019-05-05 18:10:48 +05:30
2019-07-07 11:18:12 +05:30
### Documentation
2019-05-05 18:10:48 +05:30
2020-05-24 23:13:21 +05:30
<!-- See the Feature Change Documentation Workflow https://docs.gitlab.com/ee/development/documentation/workflow.html#for-a-product-change
2020-04-22 19:07:51 +05:30
2021-03-11 19:13:27 +05:30
* Add all known Documentation Requirements in this section. See https://docs.gitlab.com/ee/development/documentation/workflow.html
2020-04-22 19:07:51 +05:30
* If this feature requires changing permissions, update the permissions document. See https://docs.gitlab.com/ee/user/permissions.html -->
2019-05-05 18:10:48 +05:30
2020-03-13 15:44:24 +05:30
### Availability & Testing
2019-05-05 18:10:48 +05:30
2020-03-13 15:44:24 +05:30
<!-- This section needs to be retained and filled in during the workflow planning breakdown phase of this feature proposal, if not earlier.
2020-04-22 19:07:51 +05:30
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?
2020-03-13 15:44:24 +05:30
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
2022-08-13 15:12:31 +05:30
See the Quality Engineering quad planning and test planning processes and reach out to your counterpart Software Engineer in Test for assistance.
Quad Planning: https://about.gitlab.com/handbook/engineering/quality/quality-engineering/quad-planning
Test Planning: https://about.gitlab.com/handbook/engineering/quality/quality-engineering/test-engineering/#test-planning -->
2019-05-05 18:10:48 +05:30
2021-03-08 18:12:59 +05:30
### Available Tier
<!-- This section should be used for setting the appropriate tier that this feature will belong to. Pricing can be found here: https://about.gitlab.com/pricing/
* Free
* Premium/Silver
* Ultimate/Gold
-->
2022-05-07 20:08:51 +05:30
### Feature Usage Metrics
2022-04-04 11:22:00 +05:30
<!-- How are you going to track usage of this feature? Think about user behavior and their interaction with the product. What indicates someone is getting value from it?
Create tracking issue using the Snowplow event tracking template. See https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/issue_templates/Snowplow%20event%20tracking.md
-->
2019-05-05 18:10:48 +05:30
### What does success look like, and how can we measure that?
2021-01-03 14:25:43 +05:30
<!--
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.
2021-11-11 11:23:49 +05:30
Create tracking issue using the Snowplow event tracking template. See https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/issue_templates/Snowplow%20event%20tracking.md
2021-01-03 14:25:43 +05:30
-->
2019-05-05 18:10:48 +05:30
2020-03-13 15:44:24 +05:30
### What is the type of buyer?
2019-12-04 20:38:33 +05:30
2020-10-24 23:57:45 +05:30
<!-- What is the buyer persona for this feature? See https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/buyer-persona/
2021-03-11 19:13:27 +05:30
In which enterprise tier should this feature go? See https://about.gitlab.com/handbook/product/pricing/#three-tiers -->
2019-12-04 20:38:33 +05:30
2020-04-08 14:13:33 +05:30
### Is this a cross-stage feature?
<!-- Communicate if this change will affect multiple Stage Groups or product areas. We recommend always start with the assumption that a feature request will have an impact into another Group. Loop in the most relevant PM and Product Designer from that Group to provide strategic support to help align the Group's broader plan and vision, as well as to avoid UX and technical debt. https://about.gitlab.com/handbook/product/#cross-stage-features -->
2022-06-21 17:19:12 +05:30
### What is the competitive advantage or differentiation for this feature?
2019-05-05 18:10:48 +05:30
### Links / references
2021-02-22 17:27:13 +05:30
<!-- Label reminders - you should have one of each of the following labels.
Use the following resources to find the appropriate labels:
2023-04-23 21:23:45 +05:30
- Use only one tier label choosing the lowest tier this is intended for
2021-02-22 17:27:13 +05:30
- https://gitlab.com/gitlab-org/gitlab/-/labels
- https://about.gitlab.com/handbook/product/categories/features/
-->
2022-03-02 08:16:31 +05:30
/label ~group:: ~section:: ~Category:
2022-01-26 12:08:38 +05:30
/label ~"GitLab Free" ~"GitLab Premium" ~"GitLab Ultimate"
2021-12-11 22:18:48 +05:30
/label ~"type::feature" ~documentation ~direction