Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define format for documenting functional requirements #25

Open
ccremer opened this issue Sep 16, 2021 · 0 comments
Open

Define format for documenting functional requirements #25

ccremer opened this issue Sep 16, 2021 · 0 comments

Comments

@ccremer
Copy link
Contributor

ccremer commented Sep 16, 2021

We currently have a standardized format for defining quality requirements. A format that makes them SMART (see #10 )

We yet lack a format for functional requirements (= features). Currently, features are in our internal ticketing system using the Gherkin language e.g.

Proposal 1

User Story sentence + free-form text, e.g.
"
As a Developer I want to create a Namespace so that I can deploy workload
additional text lorem ipsum
"

Proposal 2

User Story sentence + acceptance criteria
Use the Gherkin language to define use cases. Example
As a Developer I want to create a Namespace so that I can deploy workload

Scenario: Create project
  Given the user "jane.doe"
  And an organization named "silver-stag"
  And the user "jane.doe" belongs to organization "silver-stag"
  And the user "jane.doe" has set "silver-stag" set as default organization
  And I am logged in as user "jane.doe"
  When I create a project named "winter-shape"
  Then there is a namespace named "winter-shape"
  And the namespace has the attribute "appuio.ch/organization" with value "silver-stag"

Proposal 3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant