Skip to content

Define format for documenting functional requirements #25

@ccremer

Description

@ccremer

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions