Skip to content

Commit

Permalink
specs: try to make it clear what deliverables should be (#2495)
Browse files Browse the repository at this point in the history
Improving VEP recommendations to make sure we include expected
deliverables as part of the VEP

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
antoniivanov and pre-commit-ci[bot] authored Aug 1, 2023
1 parent 0bbf710 commit 99608ce
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions specs/NNNN-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,13 @@ Explain the user problem that need to be solved.

## Requirements and goals
<!--
It tells **what** is it trying to achieve?
List the specific goals (functional and nonfunctional requirements)? How will we
know that this has succeeded?
It tells **what** is it trying to achieve including expected deliverables.
List the specific goals (functional and nonfunctional requirements)?
It's recommended to specify metrics that can be used to check the goal has been achieved.
Specify for what type of users, what is going to be delivered.
Recommended (but not required format) is
User <persona/type of user>, they need <new deliverable/feature/improvement>, so that <reason>
Specify non-goals. Clearly, the list of non-goals can't be exhaustive.
Non-goals are only features, which a contributor can reasonably assume were a goal.
Expand Down Expand Up @@ -151,7 +155,8 @@ Consider at least the below topics but you do not need to cover those that are n

## Implementation stories
<!--
Optionally, describe what are the implementation stories (eventually we'd create github issues out of them).
Optionally, describe what are the implementation stories. Link to Milestone or initiative in Github is fine
As part of the implementation make sure to include stories covering release/launch plan, promotional activities before the release,
-->

## Alternatives
Expand Down

0 comments on commit 99608ce

Please sign in to comment.